Google.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-BqDataset --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BqDataset</command:name> <command:verb>Get</command:verb> <command:noun>BqDataset</command:noun> <maml:description> <maml:para>Lists BigQuery datasets in a specific Cloud project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If a Dataset is specified, it will return an object describing that dataset. If no Dataset is specified, this cmdlet lists all datasets in the specified project to which you have been granted the "READER" dataset role. The "-IncludeHidden" flag will include hidden datasets in the search results. The "-Filter" flag allows you to filter results by label. The syntax to filter is "name[:value]". Multiple filters can be ANDed together by passing them in as a string array. See the link below for more on labels. If no Project is specified, the default project will be used. If no Dataset was specified, this cmdlet returns any number of DatasetList.DatasetData objects. Otherwise, it returns a Dataset object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeHidden --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="All"> <maml:name>IncludeHidden</maml:name> <maml:description> <maml:para>Includes hidden datasets in the output if set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filters results by label. The syntax for each label is "/[:/]".</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetWithString --> <command:syntaxItem> <maml:name>Get-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset that you want to get a descriptor object for. This field also accepts DatasetData objects so they can be mapped to full Dataset objects.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetWithRef --> <command:syntaxItem> <maml:name>Get-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>DatasetRefrence object to get an updated Dataset object for.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeHidden --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="All"> <maml:name>IncludeHidden</maml:name> <maml:description> <maml:para>Includes hidden datasets in the output if set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="All"> <maml:name>All</maml:name> <maml:description> <maml:para>Includes hidden datasets in the output if set.</maml:para> <maml:para>This is an alias of the IncludeHidden parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filters results by label. The syntax for each label is "/[:/]".</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset that you want to get a descriptor object for. This field also accepts DatasetData objects so they can be mapped to full Dataset objects.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>DatasetRefrence object to get an updated Dataset object for.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ID of the dataset that you want to get a descriptor object for. This field also accepts DatasetData objects so they can be mapped to full Dataset objects.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>DatasetRefrence object to get an updated Dataset object for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset -Project my-project</dev:code> <dev:remarks> <maml:para>This lists all of the non-hidden datasets in the Cloud project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset -IncludeHidden -Filter "department:shipping"</dev:code> <dev:remarks> <maml:para>This lists all of the datasets in the default Cloud project for your account that have the key "department" with the value "shipping".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset -IncludeHidden -Filter "department:shipping","location:usa"</dev:code> <dev:remarks> <maml:para>This is an example of ANDing multiple filters for a list request.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset "my-dataset"</dev:code> <dev:remarks> <maml:para>This returns a Dataset object from the default project of the dataset with id "my-dataset".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Datasets] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Filtering datasets using labels] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/labeling-datasets#filtering_datasets_using_labels)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-BqDataset --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-BqDataset</command:name> <command:verb>New</command:verb> <command:noun>BqDataset</command:noun> <maml:description> <maml:para>Creates a new empty dataset in the specified project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new, empty dataset in the specified project. A Dataset can be supplied by object via the pipeline or the "-Dataset" parameter, or it can be instantiated by value with the flags below. If no Project is specified, the default project will be used. This cmdlet returns a Dataset object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>New-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>"DatasetId" must be unique within the project and match the pattern "[a-zA-Z0-9_]+".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>User-friendly name for the dataset</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the dataset.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expiration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>The default lifetime for tables in the dataset (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>New-BqDataset</maml:name> <!-- Parameter: Dataset --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The dataset object that will be sent to the server to be inserted.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The dataset object that will be sent to the server to be inserted.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>"DatasetId" must be unique within the project and match the pattern "[a-zA-Z0-9_]+".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>User-friendly name for the dataset</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the dataset.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expiration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>The default lifetime for tables in the dataset (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The dataset object that will be sent to the server to be inserted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $premade_dataset | New-BqDataset</dev:code> <dev:remarks> <maml:para>This takes a Dataset object from the pipeline and inserts it into the Cloud project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-BqDataset "test_data_id" ` -Name "Testdata" ` -Description "Some interesting data!" ` -Expiration 86400000</dev:code> <dev:remarks> <maml:para>This builds a new dataset with the supplied datasetId, name, description, and an expiration of 1 day.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Datasets] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-BqDataset --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-BqDataset</command:name> <command:verb>Remove</command:verb> <command:noun>BqDataset</command:noun> <maml:description> <maml:para>Deletes the specified dataset.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified dataset. This command takes a Dataset object as input, typically off the pipeline or through the "-Dataset" parameter. You can also specify a projectId:datasetId combination through the "-Project" and "-DatasetId" flags. The dataset must be empty to be deleted. Use the "-Force" flag if the dataset is not empty to confirm deletion of all tables in the dataset. Once this operation is complete, you may create a new dataset with the same name. If no Project is specified, the default project will be used. If the deletion runs without error, this cmdlet has no output. This cmdlet supports the ShouldProcess function, so it has the corresponding "-WhatIf" and "-Confirm" flags.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>Remove-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>DatasetId to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of tables inside a non-empty Dataset.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>Dataset to delete. Takes Dataset, DatasetsData, and DatasetReference Objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of tables inside a non-empty Dataset.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>DatasetId to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>Dataset to delete. Takes Dataset, DatasetsData, and DatasetReference Objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of tables inside a non-empty Dataset.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Dataset to delete. Takes Dataset, DatasetsData, and DatasetReference Objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset "my-values" | Remove-BqDataset</dev:code> <dev:remarks> <maml:para>This deletes "my-values" only if it is empty.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $set = Get-BqDataset "test-values" PS C:\> Remove-BqDataset $set -Force</dev:code> <dev:remarks> <maml:para>This deletes "test-values" and all of its contents.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Datasets] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [ShouldProcess] </maml:linkText> <maml:uri>(https://msdn.microsoft.com/en-us/library/ms568267.aspx)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-BqDataset --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BqDataset</command:name> <command:verb>Set</command:verb> <command:noun>BqDataset</command:noun> <maml:description> <maml:para>Updates information describing an existing BigQuery dataset.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates information describing an existing BigQuery dataset. If the dataset passed in does not already exist on the server, it will be inserted. Use the -SetLabel and -ClearLabel flags to manage the dataset's key:value label pairs. This cmdlet returns a Dataset object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Set-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The updated Dataset object. Must have the same DatasetId as an existing dataset in the project specified.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SetLabel --> <command:syntaxItem> <maml:name>Set-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The updated Dataset object. Must have the same DatasetId as an existing dataset in the project specified.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SetLabel</maml:name> <maml:description> <maml:para>Sets the labels in Keys to the values in Values for the target Dataset.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ClearLabel --> <command:syntaxItem> <maml:name>Set-BqDataset</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The updated Dataset object. Must have the same DatasetId as an existing dataset in the project specified.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClearLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearLabel</maml:name> <maml:description> <maml:para>Clears the keys in Keys for the target Dataset.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for datasets in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The updated Dataset object. Must have the same DatasetId as an existing dataset in the project specified.</maml:para> </maml:description> <command:parameterValue required="true">Dataset</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SetLabel</maml:name> <maml:description> <maml:para>Sets the labels in Keys to the values in Values for the target Dataset.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClearLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearLabel</maml:name> <maml:description> <maml:para>Clears the keys in Keys for the target Dataset.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Dataset</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated Dataset object. Must have the same DatasetId as an existing dataset in the project specified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $updatedSet = Get-BqDataset "my_dataset" PS C:\> $updatedSet.Description = "An updated summary of the data contents." PS C:\> $updatedSet | Set-BqDataset</dev:code> <dev:remarks> <maml:para>This will update the values stored for the Bigquery dataset passed in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $data = Get-BqDataset "test_set" PS C:\> $data = $data | Set-BqDataset -SetLabel @{"test"="three";"other"="two"}</dev:code> <dev:remarks> <maml:para>This will add the labels "test" and "other" with their values to "test_set".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $data = Get-BqDataset "test_set" PS C:\> $data = $data | Set-BqDataset -ClearLabel "test","other"</dev:code> <dev:remarks> <maml:para>This is the opposite of the above. It removes the labels "test" and "other" from the Dataset.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Datasets] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-BqJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BqJob</command:name> <command:verb>Get</command:verb> <command:noun>BqJob</command:noun> <maml:description> <maml:para>Lists all jobs that you started in the specified project or returns information about a specific job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no Job is specified through the JobId parameter or object via pipeline, a list of all jobs in the specified project will be returned. If a Job is specified, it will return a descriptor object for that job. Listing requires "Viewer" or "Owner" roles. Viewing information about a specific job requires the "Owner" role. Job information is stored for six months after its creation.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: GetString --> <command:syntaxItem> <maml:name>Get-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>JobId</maml:name> <maml:description> <maml:para>The ID of the Job to get a reference for. Can be passed as a string parameter or as a Job object through the pipeline. Other types accepted are JobsData and JobReference.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: GetObject --> <command:syntaxItem> <maml:name>Get-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get an updated Job object for. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Filter jobs returned by state. Options are "DONE", "PENDING", and "RUNNING"</maml:para> <maml:para>Possible values: Done, Pending, Running</maml:para> </maml:description> <command:parameterValue required="true">StateFilterEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.JobsResource+ListRequest+StateFilterEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Done</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Done</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>Forces the cmdlet to display jobs owned by all users in the project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JobId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>JobId</maml:name> <maml:description> <maml:para>The ID of the Job to get a reference for. Can be passed as a string parameter or as a Job object through the pipeline. Other types accepted are JobsData and JobReference.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get an updated Job object for. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Filter jobs returned by state. Options are "DONE", "PENDING", and "RUNNING"</maml:para> <maml:para>Possible values: Done, Pending, Running</maml:para> </maml:description> <command:parameterValue required="true">StateFilterEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.JobsResource+ListRequest+StateFilterEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Done</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Done</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" variableLength="false">Running</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>Forces the cmdlet to display jobs owned by all users in the project.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>JobReference to get an updated Job object for. Other types accepted are Job and JobsData.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-BqJob</dev:code> <dev:remarks> <maml:para>Lists all past or present jobs from the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-BqJob -ProjectId "my_project"</dev:code> <dev:remarks> <maml:para>Lists list all past or present jobs from the specified project, "my_project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $job = Get-BqJob "job_p6focacVVo29rJ4_yvn8Aabi2wQ"</dev:code> <dev:remarks> <maml:para>This returns a descriptor object for the specified job in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> $job = $job | Get-BqJob</dev:code> <dev:remarks> <maml:para>This will update the local descriptor "$job" with the most recent server state.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Jobs] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Receive-BqJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Receive-BqJob</command:name> <command:verb>Receive</command:verb> <command:noun>BqJob</command:noun> <maml:description> <maml:para>Returns the result of a completed BQ Job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the result of a completed BQ Job. Requires the "Reader" dataset role. You can specify how long the call should wait for the query to be completed, if it is not already finished. This is done with the "-Timeout" parameter. An integer number of seconds is taken, and the default is 10. This cmdlet returns BigQueryRow objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Receive-BqJob</maml:name> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Max time, in seconds, to wait for the job to complete before failing (Default: 10).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Max time, in seconds, to wait for the job to complete before failing (Default: 10).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $job = Start-BqJob -Query "select * from book_data.classics" PS C:\> $job | Receive-BqJob -Timeout 60</dev:code> <dev:remarks> <maml:para>This will run a query in the book_data.classics table and will wait up to 60 seconds for its completion. When it finishes, it will print a number of BigQueryRow objects to the terminal.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Jobs] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-BqJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-BqJob</command:name> <command:verb>Start</command:verb> <command:noun>BqJob</command:noun> <maml:description> <maml:para>Starts a new, asynchronous BigQuery Job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a new asynchronous job. This call requires the "Viewer" role. The Type parameter can be "-Query", "-Copy", "-Load", or "-Extract". Each of these job types has its own set of type-specific parameters to define what the job does (see below). Job types all share a set of parameters that define job attributes such as start time and handle statistics such as rows and raw amounts of data processed. This PowerShell module does not support billing tier or maximum billed data control for individual queries, so the project defaults will be taken. This cmdlet supports "ShouldProcess()", and as such, has the "-WhatIf" parameter to show the projected results of the cmdlet without actually changing any server resources. Use "-PollUntilComplete" to have the cmdlet treat the job as a blocking operation. It will poll until the job has finished, and then it will return a job reference. Tables referenced in queries should be fully qualified, but to use any that are not, the DefaultDataset parameter must be used to specify where to find them. | All Job Flags: -Project -PollUntilComplete | Query Job Flags: -QueryString, -UseLegacySql, -DefaultDataset, -Priority | Copy Job Flags: -Source, -Destination, WriteMode | Load Job Flags: -Destination, -Type, -SourceUris, -Encoding, -FieldDelimiter, -Quote, -SkipLeadingRows, -AllowUnknownFields, -AllowJaggedRows, -AllowQuotedNewlines | Extract Job Flags: -Source, -Type, -DestinationUris, -FieldDelimiter, -Compress, -NoHeader</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DoQuery --> <command:syntaxItem> <maml:name>Start-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to run jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PollUntilComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>PollUntilComplete</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Selects job type Query.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: QueryString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>A query string, following the BigQuery query syntax, of the query to execute.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseLegacySql --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseLegacySql</maml:name> <maml:description> <maml:para>Specifies BigQuery's legacy SQL dialect for this query.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultDataset --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultDataset</maml:name> <maml:description> <maml:para>The dataset to use for any unqualified table names in QueryString.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Priority of the query. Can be "Batch" or "Interactive".</maml:para> <maml:para>Possible values: Interactive, Batch</maml:para> </maml:description> <command:parameterValue required="true">QueryPriority</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.QueryPriority</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Interactive</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Interactive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Batch</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination table to write to.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DoCopy --> <command:syntaxItem> <maml:name>Start-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to run jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PollUntilComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>PollUntilComplete</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Copy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Copy</maml:name> <maml:description> <maml:para>Selects job type Copy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The source table to copy from.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination table to write to.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteMode</maml:name> <maml:description> <maml:para>Write Disposition of the operation. Handles what happens if the destination table already exists. If this parameter is not supplied, this defaults to WriteEmpty.</maml:para> <maml:para>Possible values: WriteAppend, WriteTruncate, WriteIfEmpty</maml:para> </maml:description> <command:parameterValue required="true">WriteDisposition</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.WriteDisposition</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WriteAppend</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteTruncate</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteIfEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: DoExtract --> <command:syntaxItem> <maml:name>Start-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to run jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PollUntilComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>PollUntilComplete</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The source table to copy from.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The format to input/output (CSV, JSON, AVRO, DATASTORE_BACKUP).</maml:para> <maml:para>Possible values: AVRO, CSV, JSON, DATASTORE_BACKUP</maml:para> </maml:description> <command:parameterValue required="true">DataFormats</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.DataFormats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AVRO</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AVRO</command:parameterValue> <command:parameterValue required="false" variableLength="false">CSV</command:parameterValue> <command:parameterValue required="false" variableLength="false">JSON</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATASTORE_BACKUP</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FieldDelimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldDelimiter</maml:name> <maml:description> <maml:para>Delimiter to use between fields in the exported data. Default value is comma (,).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>,</dev:defaultValue> </command:parameter> <!-- Parameter: Extract --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Extract</maml:name> <maml:description> <maml:para>Selects job type Extract.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationUris --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationUris</maml:name> <maml:description> <maml:para>A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Compress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Compress</maml:name> <maml:description> <maml:para>Instructs the server to output with GZIP compression. Otherwise, no compression is used.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoHeader</maml:name> <maml:description> <maml:para>Disables printing of a header row in the results. Otherwise, a header will be printed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: DoLoad --> <command:syntaxItem> <maml:name>Start-BqJob</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to run jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PollUntilComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>PollUntilComplete</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination table to write to.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteMode</maml:name> <maml:description> <maml:para>Write Disposition of the operation. Handles what happens if the destination table already exists. If this parameter is not supplied, this defaults to WriteEmpty.</maml:para> <maml:para>Possible values: WriteAppend, WriteTruncate, WriteIfEmpty</maml:para> </maml:description> <command:parameterValue required="true">WriteDisposition</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.WriteDisposition</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WriteAppend</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteTruncate</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteIfEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Load --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Load</maml:name> <maml:description> <maml:para>Selects job type Load.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The format to input/output (CSV, JSON, AVRO, DATASTORE_BACKUP).</maml:para> <maml:para>Possible values: AVRO, CSV, JSON, DATASTORE_BACKUP</maml:para> </maml:description> <command:parameterValue required="true">DataFormats</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.DataFormats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AVRO</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AVRO</command:parameterValue> <command:parameterValue required="false" variableLength="false">CSV</command:parameterValue> <command:parameterValue required="false" variableLength="false">JSON</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATASTORE_BACKUP</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceUris --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceUris</maml:name> <maml:description> <maml:para>A list of fully-qualified Google Cloud Storage URIs where data should be imported from.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The character encoding of the data. The supported values are "UTF-8" (default) or "ISO-8859-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>UTF-8</dev:defaultValue> </command:parameter> <!-- Parameter: FieldDelimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldDelimiter</maml:name> <maml:description> <maml:para>Delimiter to use between fields in the exported data. Default value is comma (,).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>,</dev:defaultValue> </command:parameter> <!-- Parameter: Quote --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quote</maml:name> <maml:description> <maml:para>The value that is used to quote data sections in a CSV file. Default value is double-quote (").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"</dev:defaultValue> </command:parameter> <!-- Parameter: SkipLeadingRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipLeadingRows</maml:name> <maml:description> <maml:para>The number of rows to skip from the input file. (Usually used for headers.)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: AllowUnknownFields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowUnknownFields</maml:name> <maml:description> <maml:para>Allows insertion of rows with fields that are not in the schema, ignoring the extra fields.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowJaggedRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowJaggedRows</maml:name> <maml:description> <maml:para>Allows insertion of rows that are missing trailing optional columns.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowQuotedNewlines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowQuotedNewlines</maml:name> <maml:description> <maml:para>Allows quoted data sections to contain newlines</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxBadRecords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxBadRecords</maml:name> <maml:description> <maml:para>The maximum number of bad records that BigQuery can ignore while running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to run jobs in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PollUntilComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>PollUntilComplete</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Synchronous"> <maml:name>Synchronous</maml:name> <maml:description> <maml:para>Turns the async call into a synchronous call by polling until the job is complete before returning. Can also be accessed by "-Synchronous".</maml:para> <maml:para>This is an alias of the PollUntilComplete parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Query --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Query</maml:name> <maml:description> <maml:para>Selects job type Query.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: QueryString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>A query string, following the BigQuery query syntax, of the query to execute.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseLegacySql --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseLegacySql</maml:name> <maml:description> <maml:para>Specifies BigQuery's legacy SQL dialect for this query.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DefaultDataset --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultDataset</maml:name> <maml:description> <maml:para>The dataset to use for any unqualified table names in QueryString.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Priority of the query. Can be "Batch" or "Interactive".</maml:para> <maml:para>Possible values: Interactive, Batch</maml:para> </maml:description> <command:parameterValue required="true">QueryPriority</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.QueryPriority</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Interactive</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Interactive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Batch</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Copy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Copy</maml:name> <maml:description> <maml:para>Selects job type Copy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The source table to copy from.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination table to write to.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteMode</maml:name> <maml:description> <maml:para>Write Disposition of the operation. Handles what happens if the destination table already exists. If this parameter is not supplied, this defaults to WriteEmpty.</maml:para> <maml:para>Possible values: WriteAppend, WriteTruncate, WriteIfEmpty</maml:para> </maml:description> <command:parameterValue required="true">WriteDisposition</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.WriteDisposition</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WriteAppend</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteTruncate</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteIfEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Load --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Load</maml:name> <maml:description> <maml:para>Selects job type Load.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The format to input/output (CSV, JSON, AVRO, DATASTORE_BACKUP).</maml:para> <maml:para>Possible values: AVRO, CSV, JSON, DATASTORE_BACKUP</maml:para> </maml:description> <command:parameterValue required="true">DataFormats</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.DataFormats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AVRO</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AVRO</command:parameterValue> <command:parameterValue required="false" variableLength="false">CSV</command:parameterValue> <command:parameterValue required="false" variableLength="false">JSON</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATASTORE_BACKUP</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SourceUris --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceUris</maml:name> <maml:description> <maml:para>A list of fully-qualified Google Cloud Storage URIs where data should be imported from.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Encoding --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>The character encoding of the data. The supported values are "UTF-8" (default) or "ISO-8859-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>UTF-8</dev:defaultValue> </command:parameter> <!-- Parameter: FieldDelimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldDelimiter</maml:name> <maml:description> <maml:para>Delimiter to use between fields in the exported data. Default value is comma (,).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>,</dev:defaultValue> </command:parameter> <!-- Parameter: Quote --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quote</maml:name> <maml:description> <maml:para>The value that is used to quote data sections in a CSV file. Default value is double-quote (").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>"</dev:defaultValue> </command:parameter> <!-- Parameter: SkipLeadingRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipLeadingRows</maml:name> <maml:description> <maml:para>The number of rows to skip from the input file. (Usually used for headers.)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: AllowUnknownFields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowUnknownFields</maml:name> <maml:description> <maml:para>Allows insertion of rows with fields that are not in the schema, ignoring the extra fields.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowJaggedRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowJaggedRows</maml:name> <maml:description> <maml:para>Allows insertion of rows that are missing trailing optional columns.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowQuotedNewlines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowQuotedNewlines</maml:name> <maml:description> <maml:para>Allows quoted data sections to contain newlines</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaxBadRecords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxBadRecords</maml:name> <maml:description> <maml:para>The maximum number of bad records that BigQuery can ignore while running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Extract --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Extract</maml:name> <maml:description> <maml:para>Selects job type Extract.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DestinationUris --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationUris</maml:name> <maml:description> <maml:para>A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Compress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Compress</maml:name> <maml:description> <maml:para>Instructs the server to output with GZIP compression. Otherwise, no compression is used.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoHeader</maml:name> <maml:description> <maml:para>Disables printing of a header row in the results. Otherwise, a header will be printed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The source table to copy from.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The destination table to write to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $job = Start-BqJob -Query "select * from book_data.classics where Year > 1900"</dev:code> <dev:remarks> <maml:para>Queries the classics table and returns a Job object so that results can be viewed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $job = Start-BqJob -Query "select * from classics where Year > 1900" ` -DefaultDataset $dataset -DestinationTable $table</dev:code> <dev:remarks> <maml:para>Queries with a default dataset and using a permanent table as the destination for results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $source_table | Get-BqTable -DatasetId "books" "classics" PS C:\> $dest_table | Get-BqTable -DatasetId "books" "suggestions" PS C:\> $source_table | Start-BqJob -Copy $dest_table -WriteMode WriteAppend -PollUntilComplete</dev:code> <dev:remarks> <maml:para>Copies the contents of the source to the end of the destination table as long as the source and destination schemas match.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> $gcspath = "gs://ps_test" PS C:\> $table | Get-BqTable -DatasetId "books" "classics" PS C:\> $job = $table | Start-BqJob -Load CSV "$gcspath/basic.csv" -SkipLeadingRows 1 -Synchronous</dev:code> <dev:remarks> <maml:para>Loads in a table from "basic.csv" in the GCS bucket "ps_test".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> $gcspath = "gs://ps_test" PS C:\> $table | Get-BqTable -DatasetId "books" "classics" PS C:\> $job = $table | Start-BqJob -Extract CSV "$gcspath/basic.csv" -Synchronous</dev:code> <dev:remarks> <maml:para>Exports the given table to a .csv file in Cloud Storage.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Jobs] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Google Cloud Storage] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Stop-BqJob --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-BqJob</command:name> <command:verb>Stop</command:verb> <command:noun>BqJob</command:noun> <maml:description> <maml:para>Requests that a running BigQuery Job be canceled.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Requests that a job be canceled. This call will return immediately, and the client is responsible for polling for job status. Canceled jobs may still incur costs. This cmdlet returns a Job object if successful.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-BqJob</maml:name> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> <command:parameterValue required="true">JobReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.JobReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>JobReference to get results from. Other types accepted are Job and JobsData.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $job = Start-BqJob -Query "SELECT * FROM book_data.classics" PS C:\> $job = $job | Stop-BqJob</dev:code> <dev:remarks> <maml:para>This will send a request to stop $job as soon as possible. "$job.Status.State" should now be "DONE", but there is a chance that the user will have to continue to poll for status with Get-BqJob.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Jobs] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-BqSchema --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-BqSchema</command:name> <command:verb>New</command:verb> <command:noun>BqSchema</command:noun> <maml:description> <maml:para>Instantiates a new BQ schema or adds a field to a pre-existing schema.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command defines one column of a TableSchema. To create a multi-row schema, either chain multiple instances of this command together on the pipeline, pass in a JSON array that describes the schema as a string with "-JSON", or pass in a file containing the JSON array with "-Filename". Required fields for each column are Name and Type. Possible values for Type include "STRING", "BYTES", "INTEGER", "FLOAT", "BOOLEAN", "TIMESTAMP", "DATE", "TIME", "DATETIME", and "RECORD" ("RECORD" indicates the field contains a nested schema). Case is ignored for both Type and Mode. Possible values for the Mode field include "REQUIRED", "REPEATED", and the default "NULLABLE". This command forwards all TableFieldSchemas that it is passed, and will add one or more new TableFieldSchema objects to the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>New-BqSchema</maml:name> <!-- Parameter: PassThruObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>PassThruObject</maml:name> <maml:description> <maml:para>Holder parameter to allow cmdlet to forward TableFieldSchemas down the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the column to be added. The name must be unique among columns in each schema.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the column to be added. Possible values include "STRING", "BYTES", "INTEGER" (INT64), "FLOAT" (FLOAT64), "BOOLEAN" (BOOL), "TIMESTAMP", "DATE", "TIME", "DATETIME", and "RECORD" (STRUCT).</maml:para> <maml:para>Possible values: STRING, BYTES, INTEGER, INT64, FLOAT, FLOAT64, BOOLEAN, BOOL, TIMESTAMP, DATE, TIME, DATETIME, RECORD, STRUCT</maml:para> </maml:description> <command:parameterValue required="true">ColumnType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.ColumnType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>STRING</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">STRING</command:parameterValue> <command:parameterValue required="false" variableLength="false">BYTES</command:parameterValue> <command:parameterValue required="false" variableLength="false">INTEGER</command:parameterValue> <command:parameterValue required="false" variableLength="false">INT64</command:parameterValue> <command:parameterValue required="false" variableLength="false">FLOAT</command:parameterValue> <command:parameterValue required="false" variableLength="false">FLOAT64</command:parameterValue> <command:parameterValue required="false" variableLength="false">BOOLEAN</command:parameterValue> <command:parameterValue required="false" variableLength="false">BOOL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TIMESTAMP</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">TIME</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATETIME</command:parameterValue> <command:parameterValue required="false" variableLength="false">RECORD</command:parameterValue> <command:parameterValue required="false" variableLength="false">STRUCT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description for this column.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode of the column to be added. Possible values include "NULLABLE", "REQUIRED", and "REPEATED". The default value is "NULLABLE".</maml:para> <maml:para>Possible values: NULLABLE, REQUIRED, REPEATED</maml:para> </maml:description> <command:parameterValue required="true">ColumnMode</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.ColumnMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NULLABLE</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NULLABLE</command:parameterValue> <command:parameterValue required="false" variableLength="false">REQUIRED</command:parameterValue> <command:parameterValue required="false" variableLength="false">REPEATED</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Describes the optional nested schema fields if the type property is set to "RECORD". Pass in an array of TableFieldSchema objects and it will be nested inside a single column.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByString --> <command:syntaxItem> <maml:name>New-BqSchema</maml:name> <!-- Parameter: PassThruObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>PassThruObject</maml:name> <maml:description> <maml:para>Holder parameter to allow cmdlet to forward TableFieldSchemas down the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSON --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSON</maml:name> <maml:description> <maml:para>JSON string of the schema. Should be in the form: [{"Name":"Title","Type":"STRING"},{"Name":"Author","Type":"STRING"},{"Name":"Year","Type":"INTEGER"}]</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFile --> <command:syntaxItem> <maml:name>New-BqSchema</maml:name> <!-- Parameter: PassThruObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>PassThruObject</maml:name> <maml:description> <maml:para>Holder parameter to allow cmdlet to forward TableFieldSchemas down the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filename --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>File to read a JSON schema from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PassThruObject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>PassThruObject</maml:name> <maml:description> <maml:para>Holder parameter to allow cmdlet to forward TableFieldSchemas down the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the column to be added. The name must be unique among columns in each schema.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the column to be added. Possible values include "STRING", "BYTES", "INTEGER" (INT64), "FLOAT" (FLOAT64), "BOOLEAN" (BOOL), "TIMESTAMP", "DATE", "TIME", "DATETIME", and "RECORD" (STRUCT).</maml:para> <maml:para>Possible values: STRING, BYTES, INTEGER, INT64, FLOAT, FLOAT64, BOOLEAN, BOOL, TIMESTAMP, DATE, TIME, DATETIME, RECORD, STRUCT</maml:para> </maml:description> <command:parameterValue required="true">ColumnType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.ColumnType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>STRING</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">STRING</command:parameterValue> <command:parameterValue required="false" variableLength="false">BYTES</command:parameterValue> <command:parameterValue required="false" variableLength="false">INTEGER</command:parameterValue> <command:parameterValue required="false" variableLength="false">INT64</command:parameterValue> <command:parameterValue required="false" variableLength="false">FLOAT</command:parameterValue> <command:parameterValue required="false" variableLength="false">FLOAT64</command:parameterValue> <command:parameterValue required="false" variableLength="false">BOOLEAN</command:parameterValue> <command:parameterValue required="false" variableLength="false">BOOL</command:parameterValue> <command:parameterValue required="false" variableLength="false">TIMESTAMP</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">TIME</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATETIME</command:parameterValue> <command:parameterValue required="false" variableLength="false">RECORD</command:parameterValue> <command:parameterValue required="false" variableLength="false">STRUCT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>An optional description for this column.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Mode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode of the column to be added. Possible values include "NULLABLE", "REQUIRED", and "REPEATED". The default value is "NULLABLE".</maml:para> <maml:para>Possible values: NULLABLE, REQUIRED, REPEATED</maml:para> </maml:description> <command:parameterValue required="true">ColumnMode</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.ColumnMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NULLABLE</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NULLABLE</command:parameterValue> <command:parameterValue required="false" variableLength="false">REQUIRED</command:parameterValue> <command:parameterValue required="false" variableLength="false">REPEATED</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Fields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Describes the optional nested schema fields if the type property is set to "RECORD". Pass in an array of TableFieldSchema objects and it will be nested inside a single column.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JSON --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>JSON</maml:name> <maml:description> <maml:para>JSON string of the schema. Should be in the form: [{"Name":"Title","Type":"STRING"},{"Name":"Author","Type":"STRING"},{"Name":"Year","Type":"INTEGER"}]</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filename --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>File to read a JSON schema from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holder parameter to allow cmdlet to forward TableFieldSchemas down the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $dataset = New-BqDataset "books" PS C:\> $table = $dataset | New-BqTable "book_info" PS C:\> $result = New-BqSchema "Author" "STRING" | New-BqSchema "Copyright" "STRING" | New-BqSchema "Title" "STRING" | Set-BqSchema $table</dev:code> <dev:remarks> <maml:para>This will create a new schema, assign it to a table, and then send the revised table to the server to be saved.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $dataset = New-BqDataset "books" PS C:\> $table = $dataset | New-BqTable "book_info" PS C:\> $result = New-BqSchema -JSON ` '[{"Name":"Title","Type":"STRING"},{"Name":"Author","Type":"STRING"},{"Name":"Year","Type":"INTEGER"}]' | Set-BqSchema $table</dev:code> <dev:remarks> <maml:para>This will create a new schema using JSON input and will assign it to a table.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-BqSchema --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BqSchema</command:name> <command:verb>Set</command:verb> <command:noun>BqSchema</command:noun> <maml:description> <maml:para>Attaches a TableSchema to a BQ Table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command takes a Table and sets its schema to be the aggregation of all TableFieldSchema objects passed in from New-BqSchema calls earlier on the pipeline. If multiple columns are passed in with the same "-Name" field, an error will be thrown. If no Table argument is passed in, the Schema object will be written to the pipeline and the cmdlet will quit. This can be used in combination with the -Schema flag in New-BqTable to apply one schema to multiple tables. If a Table is passed in, this command returns a Table object showing the updated server state. PS C:\> $table = Get-BqTable "21st_century" -DatasetId "book_data" PS C:\> $table = New-BqSchema "Title" "STRING" | Set-BqSchema $table This will create a new schema, assign it to a table, and then send the revised table to the server to be saved. PS C:\> $schema = New-BqSchema "Title" "STRING" | New-BqSchema "Author" "STRING" | Set-BqSchema PS C:\> $table1 = New-BqTable "my_table" -DatasetId "my_dataset" -Schema $schema PS C:\> $table2 = New-BqTable "another_table" -DatasetId "my_dataset" -Schema $schema This will create a new schema and save it to a variable so it can be passed into multiple table creation cmdlets.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BqSchema</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Variable to aggregate the TableFieldSchemas from the pipeline. Pipe one or TableFieldSchema object in using the New-BqSchema cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table that you wish to add this schema to.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Variable to aggregate the TableFieldSchemas from the pipeline. Pipe one or TableFieldSchema object in using the New-BqSchema cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">TableFieldSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table that you wish to add this schema to.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableFieldSchema</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Variable to aggregate the TableFieldSchemas from the pipeline. Pipe one or TableFieldSchema object in using the New-BqSchema cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $table = Get-BqTable "21st_century" -DatasetId "book_data" PS C:\> $table = New-BqSchema "Title" "STRING" | Set-BqSchema $table</dev:code> <dev:remarks> <maml:para>This will create a new schema, assign it to a table, and then send the revised table to the server to be saved.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $schema = New-BqSchema "Title" "STRING" | New-BqSchema "Author" "STRING" | Set-BqSchema PS C:\> $table1 = New-BqTable "my_table" -DatasetId "my_dataset" -Schema $schema PS C:\> $table2 = New-BqTable "another_table" -DatasetId "my_dataset" -Schema $schema</dev:code> <dev:remarks> <maml:para>This will create a new schema and save it to a variable so it can be passed into multiple table creation cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-BqTable --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BqTable</command:name> <command:verb>Get</command:verb> <command:noun>BqTable</command:noun> <maml:description> <maml:para>Lists all tables in the specified dataset or finds a specific table by name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no table is specified, lists all tables in the specified dataset (Requires the "READER" dataset role). If a table is specified, it will return the table resource. Note that this is not the actual data from the table. If no Project is specified, the default project will be used. Dataset can be specified by the "-DatasetId" parameter or by passing in a Dataset object. This cmdlet returns a single Table if a table ID is specified, and any number of TableList.TablesData objects otherwise.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>Get-BqTable</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for tables in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The ID of the table that you want to get a descriptor object for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset to search. Can be a string, a Dataset, a DatasetReference, or a DatasetsData object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByDatasetObject --> <command:syntaxItem> <maml:name>Get-BqTable</maml:name> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The ID of the table that you want to get a descriptor object for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Get-BqTable</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Table object to get a reference for.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for tables in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The ID of the table that you want to get a descriptor object for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset to search. Can be a string, a Dataset, a DatasetReference, or a DatasetsData object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Table object to get a reference for.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Table object to get a reference for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset "my_data" | Get-BqTable</dev:code> <dev:remarks> <maml:para>This will list all of the tables in the dataset "my_data" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset "my_data" | Get-BqTable "my_table"</dev:code> <dev:remarks> <maml:para>This will return a Table descriptor object for "my_table" in "my_data".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-BqTable "my_table" -Project "my_proj" -Dataset "my_data"</dev:code> <dev:remarks> <maml:para>This returns a Table descriptor object for this project:dataset:table combination.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-BqTable --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-BqTable</command:name> <command:verb>New</command:verb> <command:noun>BqTable</command:noun> <maml:description> <maml:para>Creates a new empty table in the specified project and dataset.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new empty table in the specified dataset. A Table can be supplied by object via the pipeline or the "-InputObject" parameter, or it can be instantiated by value with the flags below. The Dataset ID can be specified by passing in a string to "-DatasetId", or you can pass a Dataset or DatasetReference to the "-Dataset" parameter. Schemas can be set by passing in a TableSchema object with the "-Schema" flag. If no Project is specified, the default project will be used. This cmdlet returns a Table object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>New-BqTable</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Table object that will be sent to the server to be inserted.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>New-BqTable</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to put the table in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The DatasetId that you would like to add to. This field takes strings. To pass in an object to specify datasetId, use the Dataset parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The TableId must be unique within the Dataset and match the pattern "[a-zA-Z0-9_]+".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>User-friendly name for the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expiration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>The lifetime of this table from the time of creation (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Schema --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schema</maml:name> <maml:description> <maml:para>Schema of the new table. Created by the New-BqSchema and Set-BqSchema cmdlets.</maml:para> </maml:description> <command:parameterValue required="true">TableSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByValueWithRef --> <command:syntaxItem> <maml:name>New-BqTable</maml:name> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to add to. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The TableId must be unique within the Dataset and match the pattern "[a-zA-Z0-9_]+".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>User-friendly name for the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expiration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>The lifetime of this table from the time of creation (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Schema --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schema</maml:name> <maml:description> <maml:para>Schema of the new table. Created by the New-BqSchema and Set-BqSchema cmdlets.</maml:para> </maml:description> <command:parameterValue required="true">TableSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Table object that will be sent to the server to be inserted.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to put the table in. If not set via PowerShell parameter processing, will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The DatasetId that you would like to add to. This field takes strings. To pass in an object to specify datasetId, use the Dataset parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to add to. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The TableId must be unique within the Dataset and match the pattern "[a-zA-Z0-9_]+".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>User-friendly name for the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expiration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>The lifetime of this table from the time of creation (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Schema --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Schema</maml:name> <maml:description> <maml:para>Schema of the new table. Created by the New-BqSchema and Set-BqSchema cmdlets.</maml:para> </maml:description> <command:parameterValue required="true">TableSchema</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableSchema</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Table object that will be sent to the server to be inserted.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatasetId that you would like to add to. This field takes strings. To pass in an object to specify datasetId, use the Dataset parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Dataset that you would like to add to. This field takes Dataset or DatasetRefrence objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-BqTable "new_tab" -Dataset "my_data" -Description "Some nice data!" -Expiration (60*60*24*30)</dev:code> <dev:remarks> <maml:para>This makes a new Table called "new_tab" with a lifetime of 30 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-BqDataset "my_data" | New-BqTable "new_tab"</dev:code> <dev:remarks> <maml:para>This shows how the pipeline can be used to specify Dataset and Project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-BqTable --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-BqTable</command:name> <command:verb>Remove</command:verb> <command:noun>BqTable</command:noun> <maml:description> <maml:para>Deletes the specified table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified table from the dataset. The table to be deleted should be passed in via the pipeline or identified by DatasetId and TableId. If the table contains data, this operation will prompt the user for confirmation before any deletions are performed. To delete a non-empty table automatically, use the "-Force" parameter. If no Project is specified, the default project will be used. This cmdlet returns a Table object. This cmdlet supports the ShouldProcess function, so it has the corresponding "-WhatIf" and "-Confirm" flags.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByValue --> <command:syntaxItem> <maml:name>Remove-BqTable</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for tables in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The ID of the table that you want to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset to search. This dataset should contain the table you wish to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of non-empty tables and the data contained in them.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByDatasetObject --> <command:syntaxItem> <maml:name>Remove-BqTable</maml:name> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The ID of the table that you want to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects. This dataset should contain the table you wish to remove.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of non-empty tables and the data contained in them.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-BqTable</maml:name> <!-- Parameter: Table --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The Table object that will be sent to the server to be removed. Also takes TableReference and TableList.TablesData objects.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of non-empty tables and the data contained in them.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to look for tables in. If not set via PowerShell parameter processing, it will default to the Cloud SDK's default project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TableId</maml:name> <maml:description> <maml:para>The ID of the table that you want to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DatasetId</maml:name> <maml:description> <maml:para>The ID of the dataset to search. This dataset should contain the table you wish to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Dataset --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Dataset</maml:name> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects. This dataset should contain the table you wish to remove.</maml:para> </maml:description> <command:parameterValue required="true">DatasetReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Table</maml:name> <maml:description> <maml:para>The Table object that will be sent to the server to be removed. Also takes TableReference and TableList.TablesData objects.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces deletion of non-empty tables and the data contained in them.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.DatasetReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Dataset that you would like to search. This field takes Dataset or DatasetRefrence objects. This dataset should contain the table you wish to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Table object that will be sent to the server to be removed. Also takes TableReference and TableList.TablesData objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $table = Get-BqTable "my_table" -Dataset "my_dataset" PS C:\> $table | Remove-BqTable</dev:code> <dev:remarks> <maml:para>This will remove "my_table" if it is empty, and will prompt for user confirmation if it is not. All data in "my_table" will be deleted if the user accepts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-BqTable "my_table" -DatasetId "my_dataset" -Force</dev:code> <dev:remarks> <maml:para>This will remove "my_table" and all of its data.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-BqTable --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-BqTable</command:name> <command:verb>Set</command:verb> <command:noun>BqTable</command:noun> <maml:description> <maml:para>Updates information describing an existing BigQuery table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates information in an existing table. Pass in the updated Table object via the pipeline or the "-InputObject" parameter. This cmdlet returns the updated Table object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-BqTable</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The updated Table object. Must have the same tableId as an existing table in the dataset.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The updated Table object. Must have the same tableId as an existing table in the dataset.</maml:para> </maml:description> <command:parameterValue required="true">Table</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.Table</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The updated Table object. Must have the same tableId as an existing table in the dataset.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $my_tab = Get-BqTable "my_table" -DatasetId "my_data" PS C:\> $my_tab.Description = "Some new description!" PS C:\> $my_tab | Set-BqTable</dev:code> <dev:remarks> <maml:para>This is an example of how to locally update a field within a table and then push your changes to the cloud resource</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tables] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tables)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-BqTableRow --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-BqTableRow</command:name> <command:verb>Add</command:verb> <command:noun>BqTableRow</command:noun> <maml:description> <maml:para>Streams data from a file into BigQuery one record at a time without needing to run a load job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Streams data into BigQuery one record at a time without needing to run a load job. This cmdlet accepts CSV, JSON, and Avro files, and has a number of configuration parameters for each type. This cmdlet returns nothing if the insert completed successfully. WriteMode Options: - "WriteAppend" will add data to the existing table. - "WriteTruncate" will truncate the table before additional data is inserted. - "WriteIfEmpty" will throw an error unless the table is empty.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-BqTableRow</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The table to insert the data.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The format of the data file (CSV | JSON | AVRO).</maml:para> <maml:para>Possible values: AVRO, CSV, JSON, DATASTORE_BACKUP</maml:para> </maml:description> <command:parameterValue required="true">DataFormats</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.DataFormats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AVRO</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AVRO</command:parameterValue> <command:parameterValue required="false" variableLength="false">CSV</command:parameterValue> <command:parameterValue required="false" variableLength="false">JSON</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATASTORE_BACKUP</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Filename --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The filname containing the data to insert.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteMode</maml:name> <maml:description> <maml:para>Write Disposition of the operation. Governs what happens to the data currently in the table. If this parameter is not supplied, this defaults to "WriteAppend".</maml:para> <maml:para>Possible values: WriteAppend, WriteTruncate, WriteIfEmpty</maml:para> </maml:description> <command:parameterValue required="true">WriteDisposition</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.WriteDisposition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WriteAppend</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WriteAppend</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteTruncate</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteIfEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AllowUnknownFields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowUnknownFields</maml:name> <maml:description> <maml:para>CSV ONLY: Allows insertion of rows with fields that are not in the schema, ignoring the extra fields.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowJaggedRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowJaggedRows</maml:name> <maml:description> <maml:para>CSV ONLY: Allows insertion of rows that are missing trailing optional columns.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowQuotedNewlines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowQuotedNewlines</maml:name> <maml:description> <maml:para>CSV ONLY: Allows quoted data sections to contain newlines</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: FieldDelimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldDelimiter</maml:name> <maml:description> <maml:para>CSV ONLY: Separator between fields in the data. Default value is comma (,).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Quote --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quote</maml:name> <maml:description> <maml:para>CSV ONLY: Value used to quote data sections. Default value is double-quote (").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipLeadingRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipLeadingRows</maml:name> <maml:description> <maml:para>CSV ONLY: The number of rows to skip from the input file. (Usually used for headers.)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The table to insert the data.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The format of the data file (CSV | JSON | AVRO).</maml:para> <maml:para>Possible values: AVRO, CSV, JSON, DATASTORE_BACKUP</maml:para> </maml:description> <command:parameterValue required="true">DataFormats</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.BigQuery.DataFormats</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AVRO</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AVRO</command:parameterValue> <command:parameterValue required="false" variableLength="false">CSV</command:parameterValue> <command:parameterValue required="false" variableLength="false">JSON</command:parameterValue> <command:parameterValue required="false" variableLength="false">DATASTORE_BACKUP</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Filename --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The filname containing the data to insert.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WriteMode</maml:name> <maml:description> <maml:para>Write Disposition of the operation. Governs what happens to the data currently in the table. If this parameter is not supplied, this defaults to "WriteAppend".</maml:para> <maml:para>Possible values: WriteAppend, WriteTruncate, WriteIfEmpty</maml:para> </maml:description> <command:parameterValue required="true">WriteDisposition</command:parameterValue> <dev:type> <maml:name>Google.Cloud.BigQuery.V2.WriteDisposition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WriteAppend</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WriteAppend</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteTruncate</command:parameterValue> <command:parameterValue required="false" variableLength="false">WriteIfEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AllowUnknownFields --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowUnknownFields</maml:name> <maml:description> <maml:para>CSV ONLY: Allows insertion of rows with fields that are not in the schema, ignoring the extra fields.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowJaggedRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowJaggedRows</maml:name> <maml:description> <maml:para>CSV ONLY: Allows insertion of rows that are missing trailing optional columns.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllowQuotedNewlines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowQuotedNewlines</maml:name> <maml:description> <maml:para>CSV ONLY: Allows quoted data sections to contain newlines</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: FieldDelimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldDelimiter</maml:name> <maml:description> <maml:para>CSV ONLY: Separator between fields in the data. Default value is comma (,).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Quote --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Quote</maml:name> <maml:description> <maml:para>CSV ONLY: Value used to quote data sections. Default value is double-quote (").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipLeadingRows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipLeadingRows</maml:name> <maml:description> <maml:para>CSV ONLY: The number of rows to skip from the input file. (Usually used for headers.)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The table to insert the data.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $filename = "C:\data.json" PS C:\> $table = New-BqTable "tab_name" -DatasetId "db_name" PS C:\> $table | Add-BqTableRow JSON $filename </dev:code> <dev:remarks> <maml:para>This code will ingest a newline-delimited JSON file from the location "$filename" on local disk to db_name:tab_name in BigQuery.</maml:para> <maml:para>PS C:\> $filename = "C:\data.csv" PS C:\> $table = New-BqTable "tab_name" -DatasetId "db_name" PS C:\> $table | Add-BqTableRow CSV $filename -SkipLeadingRows 1 -AllowJaggedRows -AllowUnknownFields</maml:para> <maml:para>This code will take a CSV file and upload it to a BQ table. It will set missing fields from the CSV to null, and it will keep rows that have fields that aren't in the table's schema.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tabledata] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tabledata)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-BqTableRow --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-BqTableRow</command:name> <command:verb>Get</command:verb> <command:noun>BqTableRow</command:noun> <maml:description> <maml:para>Retrieves table data from a specified set of rows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves table data from a specified set of rows. Requires the "READER" dataset role. Rows are returned as Google.Cloud.BigQuery.V2.BigQueryRow objects. Data can be extracted by indexing by column name. (ex: row["title"] )</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-BqTableRow</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The table to export rows from.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The table to export rows from.</maml:para> </maml:description> <command:parameterValue required="true">TableReference</command:parameterValue> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Bigquery.v2.Data.TableReference</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The table to export rows from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $table = Get-BqTable "classics" -DatasetID "book_data" PS C:\> $list = $table | Get-BqTableRow</dev:code> <dev:remarks> <maml:para>Fetches all of the rows in book_data:classics and exports them to "$list".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [BigQuery Tabledata] </maml:linkText> <maml:uri>(https://cloud.google.com/bigquery/docs/reference/rest/v2/tabledata)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GcdChange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcdChange</command:name> <command:verb>Add</command:verb> <command:noun>GcdChange</command:noun> <maml:description> <maml:para>Add a new Change to a ManagedZone of a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create, execute, and return a new Change request within a specified ManagedZone of a Project.</maml:para> <maml:para>If a Project is specified, will instead create the Change in the specified ManagedZone governed by that project. Either a Change request or ResourceRecordSet[] to add/remove can be given as input.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ChangeRequestSet --> <command:syntaxItem> <maml:name>Add-GcdChange</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeRequest --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Change"> <maml:name>ChangeRequest</maml:name> <maml:description> <maml:para>Get the Change request to execute.</maml:para> </maml:description> <command:parameterValue required="true">Change</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddRmSet --> <command:syntaxItem> <maml:name>Add-GcdChange</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Add --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> <maml:description> <maml:para>Get the ResourceRecordSet(s) to add for this Change.</maml:para> </maml:description> <command:parameterValue required="true">ResourceRecordSet[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Rm"> <maml:name>Remove</maml:name> <maml:description> <maml:para>Get the ResourceRecordSet(s) to remove (must exactly match existing ones) for this Change.</maml:para> </maml:description> <command:parameterValue required="true">ResourceRecordSet[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>ManagedZone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to change.</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeRequest --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Change"> <maml:name>ChangeRequest</maml:name> <maml:description> <maml:para>Get the Change request to execute.</maml:para> </maml:description> <command:parameterValue required="true">Change</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Change"> <maml:name>Change</maml:name> <maml:description> <maml:para>Get the Change request to execute.</maml:para> <maml:para>This is an alias of the ChangeRequest parameter.</maml:para> </maml:description> <command:parameterValue required="true">Change</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Add --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> <maml:description> <maml:para>Get the ResourceRecordSet(s) to add for this Change.</maml:para> </maml:description> <command:parameterValue required="true">ResourceRecordSet[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Rm"> <maml:name>Remove</maml:name> <maml:description> <maml:para>Get the ResourceRecordSet(s) to remove (must exactly match existing ones) for this Change.</maml:para> </maml:description> <command:parameterValue required="true">ResourceRecordSet[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Rm"> <maml:name>Rm</maml:name> <maml:description> <maml:para>Get the ResourceRecordSet(s) to remove (must exactly match existing ones) for this Change.</maml:para> <maml:para>This is an alias of the Remove parameter.</maml:para> </maml:description> <command:parameterValue required="true">ResourceRecordSet[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Get the Change request to execute.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Change --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$newARecord = New-GcdResourceRecordSet -Name "gcloudexample1.com." ` -Rrdata "104.1.34.167" $oldCNAMERecord = (Get-GcdResourceRecordSet -Zone "test1" -Filter "CNAME")[0] Add-GcdChange -Project "proj" -Zone "test1" ` -Add $newARecord -Remove $oldCNAMERecord</dev:code> <dev:remarks> <maml:para>Add a new Change that adds a new A-type ResourceRecordSet, $newARecord, and removes an existing CNAME-type record, $oldCNAMERecord, from the ManagedZone "test1" (governing "gcloudexample1.com.") in the Project "testing."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $change2 = Get-GcdChange -Project "testing" -Zone "test1" -ChangeId 2 PS C:\> Add-GcdChange -Project "proj" -Zone "test1" -ChangeRequest $change2</dev:code> <dev:remarks> <maml:para>Add the Change request $change2 to the ManagedZone "test1" in the Project "testing," where $change2 is a previously executed Change request in ManagedZone "test1" that we want to apply again.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Monitoring Changes]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/monitoring)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcdChange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcdChange</command:name> <command:verb>Get</command:verb> <command:noun>GcdChange</command:noun> <maml:description> <maml:para>Gets the Change resources within a ManagedZone of a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists the ManagedZone's Change resources.</maml:para> <maml:para>If a Project is specified, will instead return the Changes in the specified ManagedZone governed by that project. The filter ChangeId can be provided to return that specific Change.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcdChange</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for changes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ChangeId</maml:name> <maml:description> <maml:para>Get the id of the specific change to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for changes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>ManagedZone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for changes.</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ChangeId</maml:name> <maml:description> <maml:para>Get the id of the specific change to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Change --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Change</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcdChange -Project "testing" -Zone "test1"</dev:code> <dev:remarks> <maml:para>Get the Change resources in the ManagedZone "test1" in the Project "testing."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcdChange -Project "testing" -Zone "test1" -ChangeId "0"</dev:code> <dev:remarks> <maml:para>Get the Change resource with id "0" in the ManagedZone "test1" in the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Monitoring Changes]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/monitoring)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GcdManagedZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcdManagedZone</command:name> <command:verb>Add</command:verb> <command:noun>GcdManagedZone</command:noun> <maml:description> <maml:para>Add a new Google DNS ManagedZone to the Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new ManagedZone.</maml:para> <maml:para>If a Project is specified, it will instead add the new ManagedZone to that project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-GcdManagedZone</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to create a new ManagedZone in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new ManagedZone to create.</maml:para> <maml:para>The name must be 1-32 characters long, begin with a letter, end with a letter or digit, and only contain lowercase letters, digits, and dashes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DnsName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DnsName</maml:name> <maml:description> <maml:para>The DNS name of the new ManagedZone.</maml:para> <maml:para>The DnsName must be a valid absolute zone and end in a period. If it does not, the cmdlet will automatically add a period before attempting zone creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Get the description of the new ManagedZone.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to create a new ManagedZone in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new ManagedZone to create.</maml:para> <maml:para>The name must be 1-32 characters long, begin with a letter, end with a letter or digit, and only contain lowercase letters, digits, and dashes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DnsName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DnsName</maml:name> <maml:description> <maml:para>The DNS name of the new ManagedZone.</maml:para> <maml:para>The DnsName must be a valid absolute zone and end in a period. If it does not, the cmdlet will automatically add a period before attempting zone creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Get the description of the new ManagedZone.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ManagedZone --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ManagedZone</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcdManagedZone -Project "testing" -Name "testzone1" ` -DnsName "gcloudexample.com." -Description "test description" </dev:code> <dev:remarks> <maml:para>Create a new ManagedZone in the DNSProject "testing" with the name "test1," DNS name "gcloudexample.com.," and description "test description."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Managing Zones]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/zones/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcdManagedZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcdManagedZone</command:name> <command:verb>Get</command:verb> <command:noun>GcdManagedZone</command:noun> <maml:description> <maml:para>Gets the Google DNS ManagedZones within a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists the Project's ManagedZones.</maml:para> <maml:para>If a Project is specified, will instead return all ManagedZones governed by that project. The filter ManagedZone can be provided to return that specific zone.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcdManagedZone</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the project to check for ManagedZones.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to return (name or id permitted).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the project to check for ManagedZones.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to return (name or id permitted).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>ManagedZone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to return (name or id permitted).</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ManagedZone --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ManagedZone</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcdManagedZone -Project "testing" </dev:code> <dev:remarks> <maml:para>Get the ManagedZones for the Project "testing."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcdManagedZone -Project "testing" -Zone "test1" </dev:code> <dev:remarks> <maml:para>Get the ManagedZone "test1" for the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Managing Zones]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/zones/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcdManagedZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcdManagedZone</command:name> <command:verb>Remove</command:verb> <command:noun>GcdManagedZone</command:noun> <maml:description> <maml:para>Removes an existing Google DNS ManagedZone within a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified ManagedZone (and returns nothing).</maml:para> <maml:para>If a Project is specified, it will instead remove the specified ManagedZone from that project. The optional switch -Force will force removal of even non-empty ManagedZones (e.g., zones with non-NS/SOA type records).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcdManagedZone</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name,Id,ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force removal of even non-empty ManagedZones (e.g., zones with non-NS/SOA type records).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name,Id,ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name,Id,ManagedZone"> <maml:name>Name</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name,Id,ManagedZone"> <maml:name>Id</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name,Id,ManagedZone"> <maml:name>ManagedZone</maml:name> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force removal of even non-empty ManagedZones (e.g., zones with non-NS/SOA type records).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Get the specific ManagedZone to delete (name or id permitted).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcdManagedZone -Project "testing" -Zone "test1" -Force</dev:code> <dev:remarks> <maml:para>Delete the (non-empty) ManagedZone "test1" from the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Managing Zones]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/zones/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcdQuota --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcdQuota</command:name> <command:verb>Get</command:verb> <command:noun>GcdQuota</command:noun> <maml:description> <maml:para>Fetch the DNS quota of an existing Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the DNS quota from the Project resource object.</maml:para> <maml:para>If a Project is specified, will instead return the DNS quota for that project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcdQuota</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to return the DNS quota of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to return the DNS quota of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Quota --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.Quota</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcdQuota -Project "testing" </dev:code> <dev:remarks> <maml:para>Get the DNS quota of the Project "testing"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Quotas]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/quota)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcdResourceRecordSet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcdResourceRecordSet</command:name> <command:verb>Get</command:verb> <command:noun>GcdResourceRecordSet</command:noun> <maml:description> <maml:para>Gets the ResourceRecordSet resources within a ManagedZone of a Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists the ManagedZone's ResourceRecordSets.</maml:para> <maml:para>If a Project is specified, the cmdlet will instead return the ResourceRecordSets in the specified ManagedZone governed by that project. The optional -Filter can be provided to restrict the ResourceRecordSet types returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcdResourceRecordSet</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for ResourceRecordSets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the type(s) of ResourceRecordSets to return (e.g., -Filter "CNAME","NS")</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Get the Project to check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for ResourceRecordSets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="ManagedZone"> <maml:name>ManagedZone</maml:name> <maml:description> <maml:para>Get the ManagedZone (name or id permitted) to check for ResourceRecordSets.</maml:para> <maml:para>This is an alias of the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the type(s) of ResourceRecordSets to return (e.g., -Filter "CNAME","NS")</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ResourceRecordSet --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcdResourceRecordSet -Project "testing" -Zone "test1"</dev:code> <dev:remarks> <maml:para>Get the ResourceRecordSet resources in the ManagedZone "test1" in the Project "testing."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcdResourceRecordSet -Project "testing" -Zone "testZone2" -Filter "NS","AAAA"</dev:code> <dev:remarks> <maml:para>Get the ResourceRecordSets of type "NS" or "AAAA" in the ManagedZone "testZone2" in the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Supported Resource Record Formats] </maml:linkText> <maml:uri>(https://cloud.google.com/dns/records/json-record)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Managing Records]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/records/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcdResourceRecordSet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcdResourceRecordSet</command:name> <command:verb>New</command:verb> <command:noun>GcdResourceRecordSet</command:noun> <maml:description> <maml:para>Create an independent new ResourceRecordSet resource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates and returns a new ResourceRecordSet resource.</maml:para> <maml:para>The newly created ResourceRecordSet will be created and returned independently, not within any Project or ManagedZone.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcdResourceRecordSet</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Get the name of the new ResourceRecordSet (e.g., "gcloudexample.com.").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rrdata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Data"> <maml:name>Rrdata</maml:name> <maml:description> <maml:para>Get the resource record data for the ResourceRecordSet.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Type</maml:name> <maml:description> <maml:para>Get the type of the ResourceRecordSet.</maml:para> <maml:para>The supported types are A, AAAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV, and TXT.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Ttl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Get the ttl, which is the number of seconds the ResourceRecordSet can be cached by resolvers.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3600</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Get the name of the new ResourceRecordSet (e.g., "gcloudexample.com.").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Rrdata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Data"> <maml:name>Rrdata</maml:name> <maml:description> <maml:para>Get the resource record data for the ResourceRecordSet.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="1" aliases="Data"> <maml:name>Data</maml:name> <maml:description> <maml:para>Get the resource record data for the ResourceRecordSet.</maml:para> <maml:para>This is an alias of the Rrdata parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Type</maml:name> <maml:description> <maml:para>Get the type of the ResourceRecordSet.</maml:para> <maml:para>The supported types are A, AAAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV, and TXT.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Ttl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Get the ttl, which is the number of seconds the ResourceRecordSet can be cached by resolvers.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3600</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ResourceRecordSet --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Dns.v1.Data.ResourceRecordSet</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcdResourceRecordSet -Name "gcloudexample.com." -Rrdata "7.5.7.8" -Type "A" -Ttl 300</dev:code> <dev:remarks> <maml:para>Create a new ResourceRecordSet resource with name "gcloudexample.com.", Rrdata ["7.5.7.8"], type "A," and ttl 300.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Supported Resource Record Formats] </maml:linkText> <maml:uri>(https://cloud.google.com/dns/records/json-record)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Managing Records]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/records/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/dns/troubleshooting)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceAddress --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceAddress</command:name> <command:verb>Add</command:verb> <command:noun>GceAddress</command:noun> <maml:description> <maml:para>Adds a new address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new static external IP address to Google Compute Engine.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Add-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the address. Will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address will be in. For non-global addresses, will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Google.Apis.Compute.v1.Data.Address object with the information used to create an address.</maml:para> </maml:description> <command:parameterValue required="true">Address</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByValues --> <command:syntaxItem> <maml:name>Add-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the address. Will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address will be in. For non-global addresses, will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to create. Must comply with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: GlobalByObject --> <command:syntaxItem> <maml:name>Add-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the address. Will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Google.Apis.Compute.v1.Data.Address object with the information used to create an address.</maml:para> </maml:description> <command:parameterValue required="true">Address</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will create a global address, rather than a region specific one.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: GlobalByValues --> <command:syntaxItem> <maml:name>Add-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the address. Will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to create. Must comply with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will create a global address, rather than a region specific one.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the address. Will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address will be in. For non-global addresses, will default to the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Google.Apis.Compute.v1.Data.Address object with the information used to create an address.</maml:para> </maml:description> <command:parameterValue required="true">Address</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to create. Must comply with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will create a global address, rather than a region specific one.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Google.Apis.Compute.v1.Data.Address object with the information used to create an address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the address to create. Must comply with RFC1035.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Address --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-GceAddress $addressName</dev:code> <dev:remarks> <maml:para>Adds an address to the default project and region:</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Add-GceAddress $addressName -Global</dev:code> <dev:remarks> <maml:para>Adds a global address to the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Address resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/addresses#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceAddress --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceAddress</command:name> <command:verb>Get</command:verb> <command:noun>GceAddress</command:noun> <maml:description> <maml:para>Gets information about a Google Compute Engine address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get an object that has information about an address.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfRegion --> <command:syntaxItem> <maml:name>Get-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address is in. Requried when listing addresses of a region. Defaults to gcloud config region when getting a non-global named address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address is in. Requried when listing addresses of a region. Defaults to gcloud config region when getting a non-global named address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Global --> <command:syntaxItem> <maml:name>Get-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will get global addresses, rather than region specific ones.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: GlobalByName --> <command:syntaxItem> <maml:name>Get-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will get global addresses, rather than region specific ones.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Required if not specified by the gcloud config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address is in. Requried when listing addresses of a region. Defaults to gcloud config region when getting a non-global named address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will get global addresses, rather than region specific ones.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the address to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Address --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-GceAddress</dev:code> <dev:remarks> <maml:para>List all global and region addresses.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-GceAddress $addressName</dev:code> <dev:remarks> <maml:para>Get a named addresses of the region of the current gcloud config.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Address resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/addresses#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceAddress --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceAddress</command:name> <command:verb>Remove</command:verb> <command:noun>GceAddress</command:noun> <maml:description> <maml:para>Removes a Google Compute Engine address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Compute Engine static external IP address.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Remove-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address is in. Defaults to the gcloud config region.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Global --> <command:syntaxItem> <maml:name>Remove-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will delete a global address, rather than a region specific one.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceAddress</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The address object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Address</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the address. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region the address is in. Defaults to the gcloud config region.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the address to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will delete a global address, rather than a region specific one.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The address object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Address</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the address to delete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Address</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The address object to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-GceAddress $addressName</dev:code> <dev:remarks> <maml:para>Removes an address of the default project and region</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Remove-GceAddress $addressName -Global</dev:code> <dev:remarks> <maml:para>Removes a global address of the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-GceAddress | Remove-GceAddress</dev:code> <dev:remarks> <maml:para>Removes all global and region specific addresses of the default project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-GceAttachedDiskConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceAttachedDiskConfig</command:name> <command:verb>New</command:verb> <command:noun>GceAttachedDiskConfig</command:noun> <maml:description> <maml:para>Use this cmdlet when you need to provide additional information to Set-GceInstance -AddDisk or Add-GceInstance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a single new AttachedDisk object. These objects are used by New-GceInstanceConfig, Add-GceInstance, Add-GceInstanceTemplate and Set-GceInstance. They provide additional information about the disk being attached, such as the local name of the disk, or whether the disk should be automatically deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Persistant --> <command:syntaxItem> <maml:name>New-GceAttachedDiskConfig</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Source</maml:name> <maml:description> <maml:para>The URI of the preexisting disk to attach to an instance.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoDelete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoDelete</maml:name> <maml:description> <maml:para>When set, disk will be deleted when the instance is.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Boot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Boot</maml:name> <maml:description> <maml:para>When set, describes the boot disk of an instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nvme --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nvme</maml:name> <maml:description> <maml:para>When set, the disk interface will be NVME rather than SCSI.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the disk on the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Set to limit the instance to read operations.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: New --> <command:syntaxItem> <maml:name>New-GceAttachedDiskConfig</maml:name> <!-- Parameter: SourceImage --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceImage</maml:name> <maml:description> <maml:para>The source image of the new disk.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the disk to create.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the type of the disk. Defaults to pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para>The size of the disk to create, in GB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoDelete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoDelete</maml:name> <maml:description> <maml:para>When set, disk will be deleted when the instance is.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Boot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Boot</maml:name> <maml:description> <maml:para>When set, describes the boot disk of an instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nvme --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nvme</maml:name> <maml:description> <maml:para>When set, the disk interface will be NVME rather than SCSI.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the disk on the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Set to limit the instance to read operations.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Source</maml:name> <maml:description> <maml:para>The URI of the preexisting disk to attach to an instance.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceImage --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceImage</maml:name> <maml:description> <maml:para>The source image of the new disk.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the disk to create.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the type of the disk. Defaults to pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para>The size of the disk to create, in GB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoDelete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoDelete</maml:name> <maml:description> <maml:para>When set, disk will be deleted when the instance is.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Boot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Boot</maml:name> <maml:description> <maml:para>When set, describes the boot disk of an instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Nvme --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Nvme</maml:name> <maml:description> <maml:para>When set, the disk interface will be NVME rather than SCSI.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DeviceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The name of the disk on the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Set to limit the instance to read operations.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The URI of the preexisting disk to attach to an instance.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The source image of the new disk.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: AttachedDisk --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $image = Get-GceImage "windows-cloud" -Family "windows-2012-r2" PS C:\> $disks = (New-GceAttachedDiskConfig $image -Boot -AutoDelete), ` (New-GceAttachedDiskConfig (Get-GceDisk "persistant-disk-name") -ReadOnly) PS C:\> Add-GceInstanceTemplate -Name "template-name" -Disk $disks</dev:code> <dev:remarks> <maml:para>Creates two attached disk objects, and creates a new template using them.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Attached Disk resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances/attachDisk#request-body)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceBackendService --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceBackendService</command:name> <command:verb>Get</command:verb> <command:noun>GceBackendService</command:noun> <maml:description> <maml:para>Gets Google Compute Engine backend services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists backend services of a project, or gets a specific one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceBackendService</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the backend services belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceBackendService</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the backend services belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the backend service to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the backend services belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the backend service to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: BackendService --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.BackendService</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceBackendService</dev:code> <dev:remarks> <maml:para>This command lists all backend services for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceBackendService "my-backendservice"</dev:code> <dev:remarks> <maml:para>This command gets the backend service named "my-backendservice".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Backend resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/backendServices#resource-representations)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceDisk --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceDisk</command:name> <command:verb>Get</command:verb> <command:noun>GceDisk</command:noun> <maml:description> <maml:para>Gets the Google Compute Engine disks associated with a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the project's Google Compute Engine disk objects.</maml:para> <maml:para>If a Project is specified, will instead return all disks owned by that project. Filters, such as Zone or Name, can be provided to restrict the objects returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for Compute Engine disks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to lookup disks in, e.g. "us-central1-a". Partial names like "us-" or "us-central1" will also work.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk you want to have returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for Compute Engine disks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to lookup disks in, e.g. "us-central1-a". Partial names like "us-" or "us-central1" will also work.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk you want to have returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Disk --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceDisk -Project "ppiper-prod" "ppiper-frontend"</dev:code> <dev:remarks> <maml:para>Get the disk named "ppiper-frontend".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Disk resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/disks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GceDisk --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceDisk</command:name> <command:verb>New</command:verb> <command:noun>GceDisk</command:noun> <maml:description> <maml:para>Creates a new Google Compute Engine disk object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new Google Compute Engine disk object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: EmptyDisk --> <command:syntaxItem> <maml:name>New-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SizeGb</maml:name> <maml:description> <maml:para>Specify the size of the disk in GiB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disk, e.g. pd-ssd or pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromImage --> <command:syntaxItem> <maml:name>New-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SizeGb</maml:name> <maml:description> <maml:para>Specify the size of the disk in GiB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disk, e.g. pd-ssd or pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Image --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Image</maml:name> <maml:description> <maml:para>Source image to apply to the disk.</maml:para> <maml:para>Use Get-GceImage to get the image to apply. For instance, to get the latest windows instance, use Get-GceImage -Family "windows-2012-r2" -Project "windows-cloud".</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromSnapshot --> <command:syntaxItem> <maml:name>New-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SizeGb</maml:name> <maml:description> <maml:para>Specify the size of the disk in GiB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disk, e.g. pd-ssd or pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Snapshot --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Snapshot</maml:name> <maml:description> <maml:para>Source snapshot to apply to the disk.</maml:para> <maml:para>Use Get-GceSnapshot to get a previously made backup snapshot to apply to this disk.</maml:para> </maml:description> <command:parameterValue required="true">Snapshot</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Optional description of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SizeGb</maml:name> <maml:description> <maml:para>Specify the size of the disk in GiB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disk, e.g. pd-ssd or pd-standard.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Image --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Image</maml:name> <maml:description> <maml:para>Source image to apply to the disk.</maml:para> <maml:para>Use Get-GceImage to get the image to apply. For instance, to get the latest windows instance, use Get-GceImage -Family "windows-2012-r2" -Project "windows-cloud".</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Snapshot --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Snapshot</maml:name> <maml:description> <maml:para>Source snapshot to apply to the disk.</maml:para> <maml:para>Use Get-GceSnapshot to get a previously made backup snapshot to apply to this disk.</maml:para> </maml:description> <command:parameterValue required="true">Snapshot</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source image to apply to the disk.</maml:para> <maml:para>Use Get-GceImage to get the image to apply. For instance, to get the latest windows instance, use Get-GceImage -Family "windows-2012-r2" -Project "windows-cloud".</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source snapshot to apply to the disk.</maml:para> <maml:para>Use Get-GceSnapshot to get a previously made backup snapshot to apply to this disk.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Disk --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GceDisk "disk-name" -SizeGb 10 -DiskType pd-ssd</dev:code> <dev:remarks> <maml:para>Creates a new empty 10GB persistant solid state disk named "disk-name" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceImage -Family "windows-2012-r2" | New-GceDisk "disk-from-image"</dev:code> <dev:remarks> <maml:para>Creates a new persistant disk from the latest windows-2012-r2 image.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceSnapshot "snapshot-name" | New-GceDisk "disk-from-snapshot" </dev:code> <dev:remarks> <maml:para>Creates a new persistant disk from the snapshot named "snapshot-name".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Disk resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/disks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceDisk --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceDisk</command:name> <command:verb>Remove</command:verb> <command:noun>GceDisk</command:noun> <maml:description> <maml:para>Deletes a Compute Engine disk.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceDisk</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to remove</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to remove</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Disk object that describes the disk to remove</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceDisk "my-disk"</dev:code> <dev:remarks> <maml:para>Removes the disk in the default project and zone named "my-disk".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceDisk "my-disk" | Remove-GceDisk</dev:code> <dev:remarks> <maml:para>Removes the disk in the default project and zone named "my-disk".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Disk resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/disks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Resize-GceDisk --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resize-GceDisk</command:name> <command:verb>Resize</command:verb> <command:noun>GceDisk</command:noun> <maml:description> <maml:para>Resize a Compute Engine disk object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resize a Compute Engine disk object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Resize-GceDisk</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSizeGb --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewSizeGb</maml:name> <maml:description> <maml:para>Specify the new size of the disk in GiB. Must be larger than the current disk size.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Resize-GceDisk</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to resize.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSizeGb --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewSizeGb</maml:name> <maml:description> <maml:para>Specify the new size of the disk in GiB. Must be larger than the current disk size.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to associate the new Compute Engine disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specific zone to create the disk in, e.g. "us-central1-a".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the disk.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to resize.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewSizeGb --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewSizeGb</maml:name> <maml:description> <maml:para>Specify the new size of the disk in GiB. Must be larger than the current disk size.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Disk object that describes the disk to resize.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Disk --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Resize-GceDisk "my-disk" 15</dev:code> <dev:remarks> <maml:para>Changes the size of the persistant disk "my-disk" to 15GB.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceDisk "my-disk" | Resize-GceDisk 15</dev:code> <dev:remarks> <maml:para>Changes the size of the persistant disk "my-disk" to 15GB.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Disk resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/disks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceFirewall --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceFirewall</command:name> <command:verb>Add</command:verb> <command:noun>GceFirewall</command:noun> <maml:description> <maml:para>Adds a new firewall rule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new firewall rule. When given a pipeline of many Firewall.AllowedData, will collect them all and create a single new firewall rule.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-GceFirewall</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to add the firewall rule to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllowedProtocol --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Allowed,Protocol"> <maml:name>AllowedProtocol</maml:name> <maml:description> <maml:para>A list of allowed protocols and ports. you can use New-GceFirewallProtocol to create them.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Google.Apis.Compute.v1.Data.Firewall+AllowedData, Google.Apis.Compute.v1, Version=1.20.0.748, Culture=neutral, PublicKeyToken=4b01fa6e34db77ab]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The human readable description of this firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Url of the network resource for this firewall rule. If empty will be the default network.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceRange</maml:name> <maml:description> <maml:para>The IP address block that this rule applies to, expressed in CIDR format. One or both of SourceRange and SourceTag may be set. If both parameters are set, an inbound connection is allowed if it matches either SourceRange or SourceTag.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceTag</maml:name> <maml:description> <maml:para>The instance tag which this rule applies to. One or both of SourceRange and SourceTag may be set. If both parameters are set, an inbound connection is allowed it matches either SourceRange or SourceTag. Source tags cannot be used to allow access to an instance's external IP address. Source tags can only be used to control traffic traveling from an instance inside the same network as the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetTag</maml:name> <maml:description> <maml:para>An instance tag indicating sets of instances located in the network that may make network connections as specified in allowed[]. If TargetTag is not specified, the firewall rule applies to all instances on the specified network.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to add the firewall rule to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllowedProtocol --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Allowed,Protocol"> <maml:name>AllowedProtocol</maml:name> <maml:description> <maml:para>A list of allowed protocols and ports. you can use New-GceFirewallProtocol to create them.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Google.Apis.Compute.v1.Data.Firewall+AllowedData, Google.Apis.Compute.v1, Version=1.20.0.748, Culture=neutral, PublicKeyToken=4b01fa6e34db77ab]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Allowed,Protocol"> <maml:name>Allowed</maml:name> <maml:description> <maml:para>A list of allowed protocols and ports. you can use New-GceFirewallProtocol to create them.</maml:para> <maml:para>This is an alias of the AllowedProtocol parameter.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Google.Apis.Compute.v1.Data.Firewall+AllowedData, Google.Apis.Compute.v1, Version=1.20.0.748, Culture=neutral, PublicKeyToken=4b01fa6e34db77ab]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Allowed,Protocol"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>A list of allowed protocols and ports. you can use New-GceFirewallProtocol to create them.</maml:para> <maml:para>This is an alias of the AllowedProtocol parameter.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Google.Apis.Compute.v1.Data.Firewall+AllowedData, Google.Apis.Compute.v1, Version=1.20.0.748, Culture=neutral, PublicKeyToken=4b01fa6e34db77ab]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The human readable description of this firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Url of the network resource for this firewall rule. If empty will be the default network.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceRange</maml:name> <maml:description> <maml:para>The IP address block that this rule applies to, expressed in CIDR format. One or both of SourceRange and SourceTag may be set. If both parameters are set, an inbound connection is allowed if it matches either SourceRange or SourceTag.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceTag</maml:name> <maml:description> <maml:para>The instance tag which this rule applies to. One or both of SourceRange and SourceTag may be set. If both parameters are set, an inbound connection is allowed it matches either SourceRange or SourceTag. Source tags cannot be used to allow access to an instance's external IP address. Source tags can only be used to control traffic traveling from an instance inside the same network as the firewall rule.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetTag</maml:name> <maml:description> <maml:para>An instance tag indicating sets of instances located in the network that may make network connections as specified in allowed[]. If TargetTag is not specified, the firewall rule applies to all instances on the specified network.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[[Google.Apis.Compute.v1.Data.Firewall+AllowedData, Google.Apis.Compute.v1, Version=1.20.0.748, Culture=neutral, PublicKeyToken=4b01fa6e34db77ab]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A list of allowed protocols and ports. you can use New-GceFirewallProtocol to create them.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Firewall --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GceFirewallProtocol tcp -Ports 80, 443 | New-GceFirewallProtocol esp | Add-GceFirewall -Name "my-firewall" -SourceTag my-source -TargetTag my-target</dev:code> <dev:remarks> <maml:para>Creates a new firewall rule in the default project named "my-firewall". The firewall allows traffic using tcp on ports 80 and 443 as well as the esp protocol from servers tagged my-source to servers tagged my-target.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Firewall resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/firewalls#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceFirewall --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceFirewall</command:name> <command:verb>Get</command:verb> <command:noun>GceFirewall</command:noun> <maml:description> <maml:para>Gets firewall rules for a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets firewall rules for a project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GceFirewall</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The Project to get the firewall rule of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirewallName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>FirewallName</maml:name> <maml:description> <maml:para>The name of the firewall rule to get. -Name and -Firewall are aliases of this parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The Project to get the firewall rule of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirewallName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>FirewallName</maml:name> <maml:description> <maml:para>The name of the firewall rule to get. -Name and -Firewall are aliases of this parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the firewall rule to get. -Name and -Firewall are aliases of this parameter.</maml:para> <maml:para>This is an alias of the FirewallName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>The name of the firewall rule to get. -Name and -Firewall are aliases of this parameter.</maml:para> <maml:para>This is an alias of the FirewallName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the firewall rule to get. -Name and -Firewall are aliases of this parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Firewall --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceFirewall</dev:code> <dev:remarks> <maml:para>Lists all firewall rules in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceFirewall "my-firewall"</dev:code> <dev:remarks> <maml:para>Gets the information of the firewall rule in the default project named "my-firewall".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Firewall resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/firewalls#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceFirewall --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceFirewall</command:name> <command:verb>Remove</command:verb> <command:noun>GceFirewall</command:noun> <maml:description> <maml:para>Removes a firewall rule from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a firewall rule from a project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceFirewall</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project from which to remove the firewall.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirewallName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>FirewallName</maml:name> <maml:description> <maml:para>The name of the firewall rule to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceFirewall</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The firewall object to be removed.</maml:para> </maml:description> <command:parameterValue required="true">Firewall</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project from which to remove the firewall.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FirewallName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>FirewallName</maml:name> <maml:description> <maml:para>The name of the firewall rule to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the firewall rule to remove.</maml:para> <maml:para>This is an alias of the FirewallName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name,Firewall"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>The name of the firewall rule to remove.</maml:para> <maml:para>This is an alias of the FirewallName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The firewall object to be removed.</maml:para> </maml:description> <command:parameterValue required="true">Firewall</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the firewall rule to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The firewall object to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceFirewall "my-firewall"</dev:code> <dev:remarks> <maml:para>Removes the firewall named "my-firewall" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Firewall resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/firewalls#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GceFirewall --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GceFirewall</command:name> <command:verb>Set</command:verb> <command:noun>GceFirewall</command:noun> <maml:description> <maml:para>Sets the data of a firewall rule.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Overwrites all data about a firewall rule.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-GceFirewall</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project that owns the firewall rule to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>The new firewall rule data.</maml:para> </maml:description> <command:parameterValue required="true">Firewall</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project that owns the firewall rule to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>The new firewall rule data.</maml:para> </maml:description> <command:parameterValue required="true">Firewall</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Firewall --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Firewall resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/firewalls#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GceFirewallProtocol --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceFirewallProtocol</command:name> <command:verb>New</command:verb> <command:noun>GceFirewallProtocol</command:noun> <maml:description> <maml:para>Creates a new object that tells a firewall to allow a protocol.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new AllowedData object which can be passed through the pipeline too the Allowed parameter of the Add-GceFirewall cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: AppendPipeline --> <command:syntaxItem> <maml:name>New-GceFirewallProtocol</maml:name> <!-- Parameter: IPProtocol --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Protocol"> <maml:name>IPProtocol</maml:name> <maml:description> <maml:para>The IP protocol that is allowed for this rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The ports which are allowed. This parameter is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed. Example inputs include: "22", "80","443", "12345-12349" and "80..443".</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Pipeline --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Pipeline</maml:name> <maml:description> <maml:para>The Pipeline to append the new AllowedData to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPProtocol --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Protocol"> <maml:name>IPProtocol</maml:name> <maml:description> <maml:para>The IP protocol that is allowed for this rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Protocol"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>The IP protocol that is allowed for this rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.</maml:para> <maml:para>This is an alias of the IPProtocol parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The ports which are allowed. This parameter is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed. Example inputs include: "22", "80","443", "12345-12349" and "80..443".</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Pipeline --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Pipeline</maml:name> <maml:description> <maml:para>The Pipeline to append the new AllowedData to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Pipeline to append the new AllowedData to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: AllowedData --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Firewall+AllowedData</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-GceFirewallProtocol tcp -Port 80, 443 | New-GceFirewallProtocol esp | Add-GceFirewall -Project "your-project" -Name "firewall-name"</dev:code> <dev:remarks> <maml:para>Creates two GceFirewallProtocol objects, and sends them to the Add-GceFirewall cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>New-GceFirewallProtocol tcp -Port 80..443 | Add-GceFirewall -Project "your-project" -Name "firewall-name"</dev:code> <dev:remarks> <maml:para>Creates a GceFirewallProtocol object with port range 80 to 443, and sends them to the Add-GceFirewall cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Firewall resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/firewalls#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceForwardingRule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceForwardingRule</command:name> <command:verb>Get</command:verb> <command:noun>GceForwardingRule</command:noun> <maml:description> <maml:para>Gets Google Compute Engine forwarding rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists forwarding rules of a project, or gets a specific one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceForwardingRule</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the forwarding rules belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will retrieve only global forwarding rules.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByGlobalName --> <command:syntaxItem> <maml:name>Get-GceForwardingRule</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the forwarding rules belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will retrieve only global forwarding rules.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the forwarding rule to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfRegion --> <command:syntaxItem> <maml:name>Get-GceForwardingRule</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the forwarding rules belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByLocalName --> <command:syntaxItem> <maml:name>Get-GceForwardingRule</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the forwarding rules belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the forwarding rule to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the forwarding rules belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Global --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Global</maml:name> <maml:description> <maml:para>If set, will retrieve only global forwarding rules.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the forwarding rule to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ForwardingRule --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ForwardingRule</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceForwardingRule</dev:code> <dev:remarks> <maml:para>This command lists all forwarding rules for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceForwardingRule -Region us-central1</dev:code> <dev:remarks> <maml:para>This command lists all forwarding rules in region "us-central1" for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceForwardingRule "my-forwarding-rule"</dev:code> <dev:remarks> <maml:para>This command gets the forwarding rule named "my-forwarding-rule" in the default project and region.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GceForwardingRule -Project my-project -Global</dev:code> <dev:remarks> <maml:para>This command lists all global forwarding rules for the project named "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-GceForwardingRule "my-forwarding-rule" -Gobal</dev:code> <dev:remarks> <maml:para>This command gets the global forwarding rule named "my-forwarding-rule" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Forwarding Rule resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/forwardingRules#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceHealthCheck --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceHealthCheck</command:name> <command:verb>Add</command:verb> <command:noun>GceHealthCheck</command:noun> <maml:description> <maml:para>Adds a Google Compute Engine health check.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ByValues --> <command:syntaxItem> <maml:name>Add-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the health check to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the health check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostHeader</maml:name> <maml:description> <maml:para>The value of the host header in the health check request. If left empty, the public IP on behalf of which this health check is performed will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The TCP port number for the health check request. Defaults to 80 for HTTP and 443 for HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestPath</maml:name> <maml:description> <maml:para>The request path for the health check request. Defaults to "/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckInterval</maml:name> <maml:description> <maml:para>How often to send a health check request. Defaults to 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>How long to wait before claiming failure. Defaults to 5 seconds. May not be greater than CheckInterval.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HealthyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthyThreshold</maml:name> <maml:description> <maml:para>Number of consecutive success required to mark an unhealthy instance healthy. Defaults to 2.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnhealthyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnhealthyThreshold</maml:name> <maml:description> <maml:para>Number of consecutive failures required to mark a healthy instance unhealthy. Defaults to 2.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will create an HTTPS health check. If not set, will create an HTTP health check.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHttpsObject --> <command:syntaxItem> <maml:name>Add-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the health check to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>Object describing a new HTTPS health check.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHttpObject --> <command:syntaxItem> <maml:name>Add-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the health check to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>Object describing a new http health check.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the health check to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the health check.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostHeader</maml:name> <maml:description> <maml:para>The value of the host header in the health check request. If left empty, the public IP on behalf of which this health check is performed will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>The TCP port number for the health check request. Defaults to 80 for HTTP and 443 for HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestPath</maml:name> <maml:description> <maml:para>The request path for the health check request. Defaults to "/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckInterval</maml:name> <maml:description> <maml:para>How often to send a health check request. Defaults to 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>How long to wait before claiming failure. Defaults to 5 seconds. May not be greater than CheckInterval.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HealthyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthyThreshold</maml:name> <maml:description> <maml:para>Number of consecutive success required to mark an unhealthy instance healthy. Defaults to 2.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UnhealthyThreshold --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UnhealthyThreshold</maml:name> <maml:description> <maml:para>Number of consecutive failures required to mark a healthy instance unhealthy. Defaults to 2.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will create an HTTPS health check. If not set, will create an HTTP health check.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>Object describing a new HTTPS health check.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>Object describing a new http health check.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object describing a new HTTPS health check.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object describing a new http health check.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: HttpHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: HttpsHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GceHealthCheck "my-health-check" -Project "my-project" -Http</dev:code> <dev:remarks> <maml:para>Adds an HTTP health check to the project named "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GceHealthCheck "my-health-check" -Https </dev:code> <dev:remarks> <maml:para>Adds an HTTPS health check to the project in the Cloud SDK config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GceHealthCheck "my-health-check" -Http -Description "Description of my health check." ` -HostHeader "mydomain.com" -Port 50 -RequestPath "/some/path" -CheckInterval "0:0:2" ` -Timeout "0:0:2" -HealthyThreshold 3 -UnhealthyThreshold 3</dev:code> <dev:remarks> <maml:para>Adds an HTTP health check with non-default values.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [HealthCheck resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceHealthCheck --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceHealthCheck</command:name> <command:verb>Get</command:verb> <command:noun>GceHealthCheck</command:noun> <maml:description> <maml:para>Gets Google Compute Engine health checks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Google Compute Engine health checks. This cmdlet can be used to retrieve both HTTP and HTTPS health checks. It can list all health checks of a project, or get a health check by name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get the health checks of. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will get health checks that use HTTP. If neither -Http nor -Https are set, Get-GceHealthCheck will retrieve both.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will get health checks that use HTTPS. If neither -Http nor -Https are set, Get-GceHealthCheck will retrieve both.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get the health checks of. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will get health checks that use HTTP. If neither -Http nor -Https are set, Get-GceHealthCheck will retrieve both.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will get health checks that use HTTPS. If neither -Http nor -Https are set, Get-GceHealthCheck will retrieve both.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the health check to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: HttpHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: HttpsHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceHealthCheck -Project "my-project"</dev:code> <dev:remarks> <maml:para>Gets all health checks of project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceHealthCheck -Https</dev:code> <dev:remarks> <maml:para>Gets all HTTPS health checks of the project in the Cloud SDK config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>; Get-GceHealthCheck "my-health-check" -Http</dev:code> <dev:remarks> <maml:para>Gets the HTTP health check named "my-health-check" in the project of the Cloud SDK config.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [HealthCheck resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceHealthCheck --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceHealthCheck</command:name> <command:verb>Remove</command:verb> <command:noun>GceHealthCheck</command:noun> <maml:description> <maml:para>Removes a Google Compute Engine health check.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Compute Engine Health check. Use this cmdlet to remove both HTTP and HTTPS health checks.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByNameHttp --> <command:syntaxItem> <maml:name>Remove-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the health check from. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTP.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNameHttps --> <command:syntaxItem> <maml:name>Remove-GceHealthCheck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the health check from. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Https --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHttpObject --> <command:syntaxItem> <maml:name>Remove-GceHealthCheck</maml:name> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTP.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>An object defining the HTTP health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHttpsObject --> <command:syntaxItem> <maml:name>Remove-GceHealthCheck</maml:name> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>An object defining the HTTPS health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the health check from. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTP.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will remove a health check that uses HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>An object defining the HTTP health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>An object defining the HTTPS health check to remove.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object defining the HTTP health check to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object defining the HTTPS health check to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceHealthCheck "my-health-check" -Project "my-project" -Http </dev:code> <dev:remarks> <maml:para>Remove HTTP health check "my-health-check" from project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GceHealthCheck "my-health-check" -Https </dev:code> <dev:remarks> <maml:para>Remove HTTPS health check "my-health-check" from the project in the Cloud SDK config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceHealthCheck -Project "my-project | Remove-GceHealthCheck</dev:code> <dev:remarks> <maml:para>Remove all health checks from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [HealthCheck resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GceHealthCheck --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GceHealthCheck</command:name> <command:verb>Set</command:verb> <command:noun>GceHealthCheck</command:noun> <maml:description> <maml:para>Sets the data of a Google Compute Engine health check.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the data of a Google Compute Engine health check. First get the health check object with Get-GceHealthCheck. Then change the data in the object you received. Finally send that object to Set-GceHealthCheck.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByHttpObject --> <command:syntaxItem> <maml:name>Set-GceHealthCheck</maml:name> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>The object describing a health check using HTTP.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByHttpsObject --> <command:syntaxItem> <maml:name>Set-GceHealthCheck</maml:name> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>The object describing a health check using HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: HttpObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpObject</maml:name> <maml:description> <maml:para>The object describing a health check using HTTP.</maml:para> </maml:description> <command:parameterValue required="true">HttpHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HttpsObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>HttpsObject</maml:name> <maml:description> <maml:para>The object describing a health check using HTTPS.</maml:para> </maml:description> <command:parameterValue required="true">HttpsHealthCheck</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object describing a health check using HTTP.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object describing a health check using HTTPS.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: HttpHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: HttpsHealthCheck --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.HttpsHealthCheck</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $healthCheck = Get-GceHealthCheck "my-health-check" -Project "my-project" PS C:\> $healthCheck.CheckIntervalSec = 30 PS C:\> $healthCheck | Set-GceHealthCheck</dev:code> <dev:remarks> <maml:para>Changes the HTTP health check "my-health-check" from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [HealthCheck resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceImage</command:name> <command:verb>Add</command:verb> <command:noun>GceImage</command:noun> <maml:description> <maml:para>Creates a Google Compute Engine image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a Google Compute Engine image from the given disk.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-GceImage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the image. This defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceDisk --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceDisk</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to build the image from. You can get this from Get-GceDisk.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to create. This defaults to the name of the disk the image is being created from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Family --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Family</maml:name> <maml:description> <maml:para>The family this image is part of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the image.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the image. This defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceDisk --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceDisk</maml:name> <maml:description> <maml:para>The Disk object that describes the disk to build the image from. You can get this from Get-GceDisk.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to create. This defaults to the name of the disk the image is being created from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Family --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Family</maml:name> <maml:description> <maml:para>The family this image is part of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the image.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Disk object that describes the disk to build the image from. You can get this from Get-GceDisk.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Image --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceDisk "my-disk" | Add-GceImage -Name "my-image" -Family "my-family"</dev:code> <dev:remarks> <maml:para>Creates a new image named "my-image" of the family "my-family" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Image resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/images#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-GceImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-GceImage</command:name> <command:verb>Disable</command:verb> <command:noun>GceImage</command:noun> <maml:description> <maml:para>Marks an image or schedules an image to be marked as DEPRECATED, OBSOLETE, or DELETED.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Marks an image or schedules an image to be marked as DEPRECATED, OBSOLETE, or DELETED.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Disable-GceImage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image to disable. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to disable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Replacement</maml:name> <maml:description> <maml:para>The Image object that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplacementUrl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplacementUrl</maml:name> <maml:description> <maml:para>The url of the image that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>State</maml:name> <maml:description> <maml:para>The new state of the image.</maml:para> <maml:para>Possible values: DEPRECATED, OBSOLETE, DELETED</maml:para> </maml:description> <command:parameterValue required="true">ImageDisableState</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.DisableGceImageCmdlet+ImageDisableState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DEPRECATED</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DEPRECATED</command:parameterValue> <command:parameterValue required="false" variableLength="false">OBSOLETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETED</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DeprecateOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeprecateOn</maml:name> <maml:description> <maml:para>The date to mark the image as deprecated.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObsoleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObsoleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as obsolete.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as deleted. The image will only be marked, and not actually destroyed until a request is made to remove it.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Disable-GceImage</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Image object that describes the image to disable.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Replacement</maml:name> <maml:description> <maml:para>The Image object that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplacementUrl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplacementUrl</maml:name> <maml:description> <maml:para>The url of the image that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>State</maml:name> <maml:description> <maml:para>The new state of the image.</maml:para> <maml:para>Possible values: DEPRECATED, OBSOLETE, DELETED</maml:para> </maml:description> <command:parameterValue required="true">ImageDisableState</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.DisableGceImageCmdlet+ImageDisableState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DEPRECATED</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DEPRECATED</command:parameterValue> <command:parameterValue required="false" variableLength="false">OBSOLETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETED</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DeprecateOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeprecateOn</maml:name> <maml:description> <maml:para>The date to mark the image as deprecated.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObsoleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObsoleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as obsolete.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as deleted. The image will only be marked, and not actually destroyed until a request is made to remove it.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image to disable. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to disable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Image object that describes the image to disable.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Replacement</maml:name> <maml:description> <maml:para>The Image object that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplacementUrl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplacementUrl</maml:name> <maml:description> <maml:para>The url of the image that is the suggested replacement for the image being disabled.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>State</maml:name> <maml:description> <maml:para>The new state of the image.</maml:para> <maml:para>Possible values: DEPRECATED, OBSOLETE, DELETED</maml:para> </maml:description> <command:parameterValue required="true">ImageDisableState</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.DisableGceImageCmdlet+ImageDisableState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DEPRECATED</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DEPRECATED</command:parameterValue> <command:parameterValue required="false" variableLength="false">OBSOLETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETED</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DeprecateOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeprecateOn</maml:name> <maml:description> <maml:para>The date to mark the image as deprecated.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObsoleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObsoleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as obsolete.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeleteOn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteOn</maml:name> <maml:description> <maml:para>The date to mark the image as deleted. The image will only be marked, and not actually destroyed until a request is made to remove it.</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the image to disable.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Image object that describes the image to disable.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Image --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $image2 = Get-GceImage "my-new-image" -Project "my-project" PS C:\> Disable-GceImage "my-old-image" -State DEPRECATED -Replacement $image2</dev:code> <dev:remarks> <maml:para>Marks the image named "my-old-image" as deprecated, and sets "my-new-image" as its replacement.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $image1 = Get-GceImage "my-old-image" -Project "my-project" PS C:\> $image2 = Get-GceImage "my-new-image" -Project "my-project" PS C:\> Disable-GceImage $image1 -State OBSOLETE -Replacement $image2</dev:code> <dev:remarks> <maml:para>Marks the image named "my-old-image" as obsolete, and sets "my-new-image" as its replacement.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Image resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/images#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceImage</command:name> <command:verb>Get</command:verb> <command:noun>GceImage</command:noun> <maml:description> <maml:para>Gets information about Google Compute Engine disk images.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about Google Compute Engine disk images. These images can be used to as the inital state of a disk, whether created manually, as part of a new instance, or from an instance tempalte.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceImage</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to get. e.g. "windows-server-2012-r2-dc-v20160623".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. This defaults to a standard set of public image projects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByFamily --> <command:syntaxItem> <maml:name>Get-GceImage</maml:name> <!-- Parameter: Family --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Family</maml:name> <maml:description> <maml:para>The name of the image family to get the latest image of. e.g. "windows-2012-r2".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. This defaults to a standard set of public image projects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceImage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. This defaults to a standard set of public image projects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeDeprecated --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDeprecated</maml:name> <maml:description> <maml:para>If set, deprecated images will be included.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to get. e.g. "windows-server-2012-r2-dc-v20160623".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Family --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Family</maml:name> <maml:description> <maml:para>The name of the image family to get the latest image of. e.g. "windows-2012-r2".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. This defaults to a standard set of public image projects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeDeprecated --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDeprecated</maml:name> <maml:description> <maml:para>If set, deprecated images will be included.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the image to get. e.g. "windows-server-2012-r2-dc-v20160623".</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Image --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceImage</dev:code> <dev:remarks> <maml:para>Lists all the standard up to date images.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceImage -Family "window-2012-r2"</dev:code> <dev:remarks> <maml:para>Gets the latest windows 2012 r2 image from the windows-cloud project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceImage "windows-server-2008-r2-dc-v20160719"</dev:code> <dev:remarks> <maml:para>Gets the image named windows-server-2008-r2-dc-v20160719 from the windows-cloud project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GceImage "my-image" -Project "my-project"</dev:code> <dev:remarks> <maml:para>Gets the custom image named "my-image" from the private project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-GceImage -Project "my-project" -IncludeDeprecated</dev:code> <dev:remarks> <maml:para>Lists all images in project "my-project", including images marked as deprecated.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Image resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/images#resource)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Google Cloud Platform images] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/images)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceImage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceImage</command:name> <command:verb>Remove</command:verb> <command:noun>GceImage</command:noun> <maml:description> <maml:para>Removes a Google Compute Engine disk image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Compute Engine disk image.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceImage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceImage</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Image object that describes the image to delete.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the image. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the image to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Image object that describes the image to delete.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the image to delete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Image object that describes the image to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceImage "my-image"</dev:code> <dev:remarks> <maml:para>Removes the image named "my-image" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceImage -Project "my-project" | Remove-GceImage</dev:code> <dev:remarks> <maml:para>Removes all images from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Image resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/images#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceInstance</command:name> <command:verb>Add</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Creates and starts a Google Compute Engine VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates and starts a Google Compute Engine VM instance. You create a new instance by either using an instance config created by New-GceInstanceConfig, or by specifying the parameters you want on this cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Add-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance will reside.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceConfig</maml:name> <maml:description> <maml:para>The definition of the instance to create.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByValues --> <command:syntaxItem> <maml:name>Add-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance will reside.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The machine type of this instance. Can be a name, a URL or a MachineType object from Get-GceMachineType. Defaults to "n1-standard-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDisk</maml:name> <maml:description> <maml:para>The persistant disk to use as a boot disk. Use Get-GceDisk to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach. It will attach in read-only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify `-BootDiskImage` or `-BootDiskSnapshot` if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, is default. This can be a Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instance will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instance will be preemptible. If set, AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instance will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instance will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens. Use New-GceServiceAccountConfig to build one.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The static ip address this instance will have. Can be a string, or and Address object from Get-GceAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance will reside.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceConfig</maml:name> <maml:description> <maml:para>The definition of the instance to create.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The machine type of this instance. Can be a name, a URL or a MachineType object from Get-GceMachineType. Defaults to "n1-standard-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDisk</maml:name> <maml:description> <maml:para>The persistant disk to use as a boot disk. Use Get-GceDisk to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>DiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> <maml:para>This is an alias of the BootDiskImage parameter.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach. It will attach in read-only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify `-BootDiskImage` or `-BootDiskSnapshot` if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, is default. This can be a Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instance will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instance will be preemptible. If set, AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instance will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instance will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens. Use New-GceServiceAccountConfig to build one.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The static ip address this instance will have. Can be a string, or and Address object from Get-GceAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The definition of the instance to create.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GceInstanceConfig -Name "new-instance" -BootDiskImage $image | Add-GceInstance -Project "my-project" -Zone "us-central1-a"</dev:code> <dev:remarks> <maml:para>Creates a new instance from an instance config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GceInstance -Name "new-instance" -BootDisk $disk ` -MachineType "n1-standard-4" ` -Tag http, https ` -Metadata @{"windows-startup-script-ps1" = "Read-GcsObject bucket object -OutFile temp.txt"}</dev:code> <dev:remarks> <maml:para>Creates a new instance in the default project and zone. The boot disk is the prexisting disk stored in $disk, the machine type has 4 cores, it runs a script on startup, and it is tagged as an http and https server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GceInstance -Name "new-instance" -BootDisk $disk ` -MachineType "n1-standard-4" ` -Subnetwork "my-subnetwork" ` -Address "10.128.0.1"</dev:code> <dev:remarks> <maml:para>Creates a new instance in the default project and zone. The boot disk is the prexisting disk stored in $disk, the machine type has 4 cores, it uses the subnetwork "my-subnetwork" and the ip address "10.123.0.1" (this address must be within the subnetwork).</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceInstance</command:name> <command:verb>Get</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Gets information about one or more Google Compute Engine VM instances.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about all Google Compute Engine VM instances. Can get all instances of a project, or all instances in a zone, or a specific instance by name. Can also get all instances of a managed instance group.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfZone --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfInstanceGroupManager --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ManagedGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagedGroupName</maml:name> <maml:description> <maml:para>The name of the instance group manager to get the instances of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Instance object to get a new copy of.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfInstanceGroupManagerObject --> <command:syntaxItem> <maml:name>Get-GceInstance</maml:name> <!-- Parameter: ManagedGroupObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ManagedGroupObject</maml:name> <maml:description> <maml:para>The InstanceGroupManager object to get the instances of.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Instance object to get a new copy of.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ManagedGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagedGroupName</maml:name> <maml:description> <maml:para>The name of the instance group manager to get the instances of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ManagedGroupObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ManagedGroupObject</maml:name> <maml:description> <maml:para>The InstanceGroupManager object to get the instances of.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SerialPortOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SerialPortOutput</maml:name> <maml:description> <maml:para>When this switch is set, the cmdlet will output the string contents of the serial port of the instance rather than the normal data about the instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the serial port to read from. Defaults to 1. Has no effect if -SerialPortOutput is not set. Must be between 1 and 4, inclusive.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Instance object to get a new copy of.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The InstanceGroupManager object to get the instances of.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Project "my-project"</dev:code> <dev:remarks> <maml:para>Gets all instances of the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Zone "us-west1-a"</dev:code> <dev:remarks> <maml:para>Gets all instances in the zone "us-west1-a" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance "my-instance"</dev:code> <dev:remarks> <maml:para>Gets the instance named "my-instance" in the default project and zone</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -ManagedGroupName "my-group"</dev:code> <dev:remarks> <maml:para>Gets all instances that are members of the managed instance group named "my-group".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance "my-instance" -SerialPortOutput -Port 4.</dev:code> <dev:remarks> <maml:para>Returns the data from serial port 4 of "my-instance".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceInstance</command:name> <command:verb>Remove</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Deletes a Google Compute Engine VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a Google Compute Engine VM instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to delete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance object to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceInstance "my-instance"</dev:code> <dev:remarks> <maml:para>Removes the instance named "my-instance" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Project "my-project"| where Status -eq Stopped | Remove-GceInstance</dev:code> <dev:remarks> <maml:para>Removes all instances in project "my-project" that are currently stopped.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Restart-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-GceInstance</command:name> <command:verb>Restart</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Resets a Google Compute Engine VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resets a Google Compute Engine VM instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Restart-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to reset.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Restart-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to restart.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to reset.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to restart.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to reset.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance object to restart.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Reset-GceInstance "my-instance"</dev:code> <dev:remarks> <maml:para>Resets the instance named "my-instance" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Project "my-project"| Reset-GceInstance</dev:code> <dev:remarks> <maml:para>Removes all instances in project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GceInstance</command:name> <command:verb>Set</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Sets various attributes of a VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>With this cmdlet, you can update metadata, attach and detach disks, add and remove acces configs, or add and remove tags.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: AccessConfig --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetworkInterface --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>The name of the network interface to add or remove access configs.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddAccessConfig</maml:name> <maml:description> <maml:para>The new access config to add to a network interface.</maml:para> </maml:description> <command:parameterValue required="true">AccessConfig[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AccessConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Google.Apis.Compute.v1.Data.AccessConfig[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAccessConfig</maml:name> <maml:description> <maml:para>The name of the access config to remove from the network interface.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Disk --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddDisk</maml:name> <maml:description> <maml:para>The disk to attach. Can the name of a disk, a disk object from Get-GceDisk, or an attached disk object from New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveDisk</maml:name> <maml:description> <maml:para>The name of the disk to detach.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AutoDeleteDisk --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TurnOnAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOnAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn on autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: TurnOffAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOffAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn off autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Metadata --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddMetadata</maml:name> <maml:description> <maml:para>The keys and values of the metadata to add.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Collections.Hashtable</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveMetadata</maml:name> <maml:description> <maml:para>The keys of the metadata to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Tag --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddTag</maml:name> <maml:description> <maml:para>The tag to add.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveTag</maml:name> <maml:description> <maml:para>The tag to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AccessConfigByObject --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetworkInterface --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>The name of the network interface to add or remove access configs.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddAccessConfig</maml:name> <maml:description> <maml:para>The new access config to add to a network interface.</maml:para> </maml:description> <command:parameterValue required="true">AccessConfig[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AccessConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Google.Apis.Compute.v1.Data.AccessConfig[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAccessConfig</maml:name> <maml:description> <maml:para>The name of the access config to remove from the network interface.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: DiskByObject --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddDisk</maml:name> <maml:description> <maml:para>The disk to attach. Can the name of a disk, a disk object from Get-GceDisk, or an attached disk object from New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveDisk</maml:name> <maml:description> <maml:para>The name of the disk to detach.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AutoDeleteDiskByObject --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TurnOnAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOnAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn on autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: TurnOffAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOffAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn off autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: MetadataByObject --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddMetadata</maml:name> <maml:description> <maml:para>The keys and values of the metadata to add.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Collections.Hashtable</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveMetadata</maml:name> <maml:description> <maml:para>The keys of the metadata to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: TagByObject --> <command:syntaxItem> <maml:name>Set-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddTag</maml:name> <maml:description> <maml:para>The tag to add.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveTag</maml:name> <maml:description> <maml:para>The tag to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetworkInterface --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>The name of the network interface to add or remove access configs.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddAccessConfig</maml:name> <maml:description> <maml:para>The new access config to add to a network interface.</maml:para> </maml:description> <command:parameterValue required="true">AccessConfig[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AccessConfig[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Google.Apis.Compute.v1.Data.AccessConfig[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveAccessConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveAccessConfig</maml:name> <maml:description> <maml:para>The name of the access config to remove from the network interface.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: AddDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddDisk</maml:name> <maml:description> <maml:para>The disk to attach. Can the name of a disk, a disk object from Get-GceDisk, or an attached disk object from New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">object[]</command:parameterValue> <dev:type> <maml:name>System.Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Object[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveDisk</maml:name> <maml:description> <maml:para>The name of the disk to detach.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: TurnOnAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOnAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn on autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: TurnOffAutoDeleteDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TurnOffAutoDeleteDisk</maml:name> <maml:description> <maml:para>The names of the disks to turn off autodelete.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: AddMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddMetadata</maml:name> <maml:description> <maml:para>The keys and values of the metadata to add.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Collections.Hashtable</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveMetadata</maml:name> <maml:description> <maml:para>The keys of the metadata to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: AddTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddTag</maml:name> <maml:description> <maml:para>The tag to add.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveTag</maml:name> <maml:description> <maml:para>The tag to remove.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to update.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance object to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GceInstance -Name "my-instance" -AttachDisk $disk</dev:code> <dev:remarks> <maml:para>Attach disk $disk to the instance "my-instance" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GceInstance -Name "my-instance" -RemoveDisk "my-disk" -Project "my-project"</dev:code> <dev:remarks> <maml:para>Remove disk "my-disk" from the instance "my-instance" in the project "my-project". Please note that "my-disk" is the device name of the disk in the instance, not the persistent name of the disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GceInstance -Name "my-instance" -TurnOnAutoDeleteDisk "my-disk"</dev:code> <dev:remarks> <maml:para>Turn on autodelete for disk "my-disk" from the instance "my-instance". Please note that "my-disk" is the device name of the disk in the instance, not the persistent name of the disk.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Set-GceInstance -Name "my-instance" -TurnOffAutoDeleteDisk $disk1, $disk2</dev:code> <dev:remarks> <maml:para>Turn off autodelete for disk $disk1 and $disk2 from the instance "my-instance".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GceInstance</command:name> <command:verb>Start</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Starts a Google Compute Engine VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts a Google Compute Engine VM instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Start-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to start.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Start-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to start.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to start.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to start.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to start.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance object to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Start-GceInstance "my-instance"</dev:code> <dev:remarks> <maml:para>Starts the instance named "my-instance" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Project "my-project"| where Status -eq Stopped | Start-GceInstance</dev:code> <dev:remarks> <maml:para>Starts all instances in project "my-project" that are currently stopped.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Stop-GceInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-GceInstance</command:name> <command:verb>Stop</command:verb> <command:noun>GceInstance</command:noun> <maml:description> <maml:para>Stops a Google Compute Engine VM instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops a Google Compute Engine VM instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Stop-GceInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to stop.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Stop-GceInstance</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to stop.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the instance resides.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance to stop.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance object to stop.</maml:para> </maml:description> <command:parameterValue required="true">Instance</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to stop.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance object to stop.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Stop-GceInstance "my-instance"</dev:code> <dev:remarks> <maml:para>Stops the instance named "my-instance" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance -Project "my-project"| where Status -eq Running | Stop-GceInstance</dev:code> <dev:remarks> <maml:para>Stops all instances in project "my-project" that are currently running.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GceInstanceConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceInstanceConfig</command:name> <command:verb>New</command:verb> <command:noun>GceInstanceConfig</command:noun> <maml:description> <maml:para>Makes a new Google Compute Engine VM instance description.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Makes a new Google Compute Engine VM instance description. Use Add-GceInstance to instantiate the instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GceInstanceConfig</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance. The name must be 1-63 characters long and match [a-z]([-a-z0-9]*[a-z0-9])?</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The machine type of this instance. Can be a name, a URL or a MachineType object from Get-GceMachineType. Defaults to "n1-standard-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDisk</maml:name> <maml:description> <maml:para>The persistant disk to use as a boot disk. Use Get-GceDisk to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach in read only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify -BootDiskImage or -BootDiskSnapshot if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, is default. This can be a Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instances will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instances will be preemptible. If set, AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instances will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instances will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The static ip address this instance will have. Can be a string, or and Address object from Get-GceAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance. The name must be 1-63 characters long and match [a-z]([-a-z0-9]*[a-z0-9])?</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The machine type of this instance. Can be a name, a URL or a MachineType object from Get-GceMachineType. Defaults to "n1-standard-1".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDisk</maml:name> <maml:description> <maml:para>The persistant disk to use as a boot disk. Use Get-GceDisk to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="DiskImage"> <maml:name>DiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> <maml:para>This is an alias of the BootDiskImage parameter.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach in read only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify -BootDiskImage or -BootDiskSnapshot if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, is default. This can be a Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instances will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instances will be preemptible. If set, AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instances will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instances will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>The static ip address this instance will have. Can be a string, or and Address object from Get-GceAddress.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance. The name must be 1-63 characters long and match [a-z]([-a-z0-9]*[a-z0-9])?</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Instance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $config = New-GceInstanceConfig -Name "new-instance" -BootDiskImage $image</dev:code> <dev:remarks> <maml:para>Creates a new instance description and saves it to $config. The new instance will create a new boot disk from $image.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $config = New-GceInstanceConfig -Name "new-instance" -BootDiskImage $image -Subnetwork "my-subnetwork"</dev:code> <dev:remarks> <maml:para>Creates a new instance description and saves it to $config. The new instance will create a new boot disk from $image and uses subnetwork "my-subnetwork".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceInstanceTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceInstanceTemplate</command:name> <command:verb>Add</command:verb> <command:noun>GceInstanceTemplate</command:noun> <maml:description> <maml:para>Adds an instance template to Google Compute Engine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds an instance template to Google Compute Engine. These templates can be used to create managed instance groups.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromObject --> <command:syntaxItem> <maml:name>Add-GceInstanceTemplate</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An instance template object to add to Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByValues --> <command:syntaxItem> <maml:name>Add-GceInstanceTemplate</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The name of the machine type for this template. Defaults to n1-standard-1.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach. All instances of this template will be able to read this disk. Will attach in read only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify `-BootDiskImage` or `-BootDiskSnapshot` if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, it is global/networks/default. This can be a string, or Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instances will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instances will be preemptible, and AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instances will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instances will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens. Use New-GceServiceAccountConfig to build one.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An instance template object to add to Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineType</maml:name> <maml:description> <maml:para>The name of the machine type for this template. Defaults to n1-standard-1.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: CanIpForward --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanIpForward</maml:name> <maml:description> <maml:para>Enables instances to send and receive packets for IP addresses other than their own. Switch on if these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this instance template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BootDiskImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BootDiskImage</maml:name> <maml:description> <maml:para>The the image used to create the boot disk. Use Get-GceImage to get one of these.</maml:para> </maml:description> <command:parameterValue required="true">Image</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Image</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtraDisk</maml:name> <maml:description> <maml:para>An existing disk to attach. All instances of this template will be able to read this disk. Will attach in read only mode.</maml:para> </maml:description> <command:parameterValue required="true">Disk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Disk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disk</maml:name> <maml:description> <maml:para>An AttachedDisk object specifying a disk to attach. Do not specify `-BootDiskImage` or `-BootDiskSnapshot` if this is a boot disk. You can build one using New-GceAttachedDiskConfig.</maml:para> </maml:description> <command:parameterValue required="true">AttachedDisk[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.AttachedDisk[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The keys and values of the Metadata of this instance.</maml:para> </maml:description> <command:parameterValue required="true">IDictionary</command:parameterValue> <dev:type> <maml:name>System.Collections.IDictionary</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to use. If not specified, it is global/networks/default. This can be a string, or Network object you get from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region in which the subnet of the instance will reside. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the subnetwork to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoExternalIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExternalIp</maml:name> <maml:description> <maml:para>If set, the instances will not have an external ip address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, the instances will be preemptible, and AutomaticRestart will be false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutomaticRestart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutomaticRestart</maml:name> <maml:description> <maml:para>If set, the instances will not restart when shut down by Google Compute Engine.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: TerminateOnMaintenance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TerminateOnMaintenance</maml:name> <maml:description> <maml:para>If set, the instances will terminate rather than migrate when the host undergoes maintenance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The ServiceAccount used to specify access tokens. Use New-GceServiceAccountConfig to build one.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>A tag of this instance.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An instance template object to add to Google Compute Engine.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InstanceTemplate --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $image = Get-GceImage -Family "window-2012-r2" PS C:\> Add-GceInstanceTemplate "my-template" -BootDiskImage $image</dev:code> <dev:remarks> <maml:para>Creates a new windows 2012 instance template with default settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $image = Get-GceImage -Family "window-2012-r2" PS C:\> Add-GceInstanceTemplate "my-template" -BootDiskImage $image -Subnetwork "my-subnet"</dev:code> <dev:remarks> <maml:para>Creates a new windows 2012 instance template with default settings and uses subnetwork "my-subnet".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $image = Get-GceImage -Family "window-2012-r2" PS C:\> $serviceAccount = New-GceServiceAccountConfig default -BigQuery PS C:\> Add-GceInstanceTemplate $name "n1-standard-4" -BootDiskImage $image ` -ServiceAccount $serviceAccount</dev:code> <dev:remarks> <maml:para>Creates a new instance template for a 4 core machine that has access to BigQuery.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance Template resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceInstanceTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceInstanceTemplate</command:name> <command:verb>Get</command:verb> <command:noun>GceInstanceTemplate</command:noun> <maml:description> <maml:para>Gets Google Compute Engine instance templates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Google Compute Engine instance templates.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: default --> <command:syntaxItem> <maml:name>Get-GceInstanceTemplate</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: byName --> <command:syntaxItem> <maml:name>Get-GceInstanceTemplate</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the tempate to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: byObject --> <command:syntaxItem> <maml:name>Get-GceInstanceTemplate</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>A template object. It must have valid SelfLink and Name attributes.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the tempate to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>A template object. It must have valid SelfLink and Name attributes.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the tempate to get.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A template object. It must have valid SelfLink and Name attributes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InstanceTemplate --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceInstanceTemplate</dev:code> <dev:remarks> <maml:para>Lists all instance templates in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstanceTemplate "my-template"</dev:code> <dev:remarks> <maml:para>Gets the instance template naemd "my-template" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance Template resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceInstanceTemplate --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceInstanceTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>GceInstanceTemplate</command:noun> <maml:description> <maml:para>Deletes a Google Compute Engine instance templates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a Google Compute Engine instance templates. Templates referenced by managed instance groups can not be deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceInstanceTemplate</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the template to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceInstanceTemplate</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance tempate object to delete.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the template to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The instance tempate object to delete.</maml:para> </maml:description> <command:parameterValue required="true">InstanceTemplate</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the template to delete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceTemplate</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance tempate object to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceInstanceTemplate "my-template"</dev:code> <dev:remarks> <maml:para>Removes the instance template named "my-template" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceInstanceTemplate | Remove-GceInstanceTemplate</dev:code> <dev:remarks> <maml:para>Removes all instance templates in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance Template resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceMachineType --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceMachineType</command:name> <command:verb>Get</command:verb> <command:noun>GceMachineType</command:noun> <maml:description> <maml:para>Get Google Compute Engine machine types.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all machine types of a project, or all machine types of a project in a zone, or a single machine type of a project in a zone with a name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfZone --> <command:syntaxItem> <maml:name>Get-GceMachineType</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceMachineType</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: MachineType --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.MachineType</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceMachineType</dev:code> <dev:remarks> <maml:para>Lists all machine types for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceMachineType -Zone "us-central1-a"</dev:code> <dev:remarks> <maml:para>Lists all machine types in zone us-central1-a for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceMachineType "f1-micro"</dev:code> <dev:remarks> <maml:para>Gets the machine type named f1-micro in the default project and zone.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Machine Type resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/machineTypes#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceManagedInstanceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceManagedInstanceGroup</command:name> <command:verb>Add</command:verb> <command:noun>GceManagedInstanceGroup</command:noun> <maml:description> <maml:para>Creates a new Google Compute Engine instance group manager.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new Google Compute Engine instance group manager.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByProperties --> <command:syntaxItem> <maml:name>Add-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone where the instance gorup will live.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceTemplate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InstanceTemplate</maml:name> <maml:description> <maml:para>The instance template to use when creating instances. Can be a string URL to a template, or an InstanceTemplate object from Get-GceInstanceTemplate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetSize --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetSize</maml:name> <maml:description> <maml:para>The target number of instances for this instance group to have.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BaseInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseInstanceName</maml:name> <maml:description> <maml:para>The base instance name for this group. Instances will take this name and append a hypen and a random four character string. Defaults to the group name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The human readable description of this instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPool --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPool</maml:name> <maml:description> <maml:para>The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PortName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortName</maml:name> <maml:description> <maml:para>The name you want to give to a port. Must have the same number of elements as PortNumber.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the port you want to give a name. Must have the same number of elements as PortName.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Int32[]</dev:defaultValue> </command:parameter> <!-- Parameter: NamedPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamedPort</maml:name> <maml:description> <maml:para>A NamedPort object you want to include in the list of named ports.</maml:para> </maml:description> <command:parameterValue required="true">NamedPort[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.NamedPort[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Add-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone where the instance gorup will live.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An InstanceGroupManager object used to create a new managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that will own the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone where the instance gorup will live.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceTemplate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InstanceTemplate</maml:name> <maml:description> <maml:para>The instance template to use when creating instances. Can be a string URL to a template, or an InstanceTemplate object from Get-GceInstanceTemplate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetSize --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetSize</maml:name> <maml:description> <maml:para>The target number of instances for this instance group to have.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BaseInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseInstanceName</maml:name> <maml:description> <maml:para>The base instance name for this group. Instances will take this name and append a hypen and a random four character string. Defaults to the group name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The human readable description of this instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPool --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPool</maml:name> <maml:description> <maml:para>The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PortName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortName</maml:name> <maml:description> <maml:para>The name you want to give to a port. Must have the same number of elements as PortNumber.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: PortNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>The number of the port you want to give a name. Must have the same number of elements as PortName.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Int32[]</dev:defaultValue> </command:parameter> <!-- Parameter: NamedPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamedPort</maml:name> <maml:description> <maml:para>A NamedPort object you want to include in the list of named ports.</maml:para> </maml:description> <command:parameterValue required="true">NamedPort[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.NamedPort[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An InstanceGroupManager object used to create a new managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An InstanceGroupManager object used to create a new managed instance group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InstanceGroupManager --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $template = Get-GceInstanceTemplate "my-template" PS C:\> Add-GceManagedInstanceGroup "my-instance-group" $template 4</dev:code> <dev:remarks> <maml:para>Creates a new managed instance group named "my-instance-group". The instance of the group will be created from template "my-template" and the group will create four instances.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managed Instance Group resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceGroupManagers#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceManagedInstanceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceManagedInstanceGroup</command:name> <command:verb>Get</command:verb> <command:noun>GceManagedInstanceGroup</command:noun> <maml:description> <maml:para>Gets Google Compute Engine instance group managers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Google Compute Engine instance group managers.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ListProject --> <command:syntaxItem> <maml:name>Get-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ListZone --> <command:syntaxItem> <maml:name>Get-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance group to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByUri --> <command:syntaxItem> <maml:name>Get-GceManagedInstanceGroup</maml:name> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The full uri of the managed instance group</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Get-GceManagedInstanceGroup</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The InstanceGroupManager object to get.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the instance group to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The full uri of the managed instance group</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The InstanceGroupManager object to get.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstanceStatus</maml:name> <maml:description> <maml:para>If set, will return ManagedInstance objects describing the state of the instances of this group, including whether they exist yet or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance group to get.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The InstanceGroupManager object to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InstanceGroupManager --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ManagedInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ManagedInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceManagedInstanceGroup</dev:code> <dev:remarks> <maml:para>Lists all managed instance groups for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceManagedInstanceGroup -Zone "us-central1-a"</dev:code> <dev:remarks> <maml:para>Lists all managed instance groups for the default project in the given zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceManagedInstanceGroup "my-instance-group" -InstanceStatus</dev:code> <dev:remarks> <maml:para>Lists the status of all members of the instance group named "my-instance-group" in the default project and zone.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managed Instance Group resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceGroupManagers#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceManagedInstanceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceManagedInstanceGroup</command:name> <command:verb>Remove</command:verb> <command:noun>GceManagedInstanceGroup</command:noun> <maml:description> <maml:para>Removes a Google Compute Engine instance group manager.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Compute Engine instance group manager.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceManagedInstanceGroup</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The managed instance group object to delete.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The managed instance group object to delete.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the managed instance group to delete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The managed instance group object to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceManagedInstanceGroup "my-instance-group"</dev:code> <dev:remarks> <maml:para>Removes the instance group named "my-instance-group" in the default project and zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceManagedInstanceGroup -Zone "us-central1-a" | Remove-GceManagedInstanceGroup</dev:code> <dev:remarks> <maml:para>Removes all managed instance groups of the default project in zone "us-central1-a".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managed Instance Group resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceGroupManagers#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GceManagedInstanceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GceManagedInstanceGroup</command:name> <command:verb>Set</command:verb> <command:noun>GceManagedInstanceGroup</command:noun> <maml:description> <maml:para>Changes the data of a Google Compute Engine instance group manager.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Changes the data of a Google Compute Engine instance group manager. As a whole, the group can be resized, have its template set, or have its target pools set. Member instances can be abandoned, deleted, or recreated.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: AbandonUri --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Abandon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Abandon</maml:name> <maml:description> <maml:para>If set, will abandon the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceUri</maml:name> <maml:description> <maml:para>The uri of the instance to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AbandonObject --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Abandon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Abandon</maml:name> <maml:description> <maml:para>If set, will abandon the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance object to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">Instance[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DeleteUri --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Delete</maml:name> <maml:description> <maml:para>If set, will delete the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceUri</maml:name> <maml:description> <maml:para>The uri of the instance to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DeleteObject --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Delete</maml:name> <maml:description> <maml:para>If set, will delete the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance object to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">Instance[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RecreateUri --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recreate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Recreate</maml:name> <maml:description> <maml:para>If set, will recreate the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceUri</maml:name> <maml:description> <maml:para>The uri of the instance to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RecreateObject --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recreate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Recreate</maml:name> <maml:description> <maml:para>If set, will recreate the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance object to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">Instance[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Resize --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Size --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para>The new target size of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: SetTemplate --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Uri to the new template of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SetTargetPools --> <command:syntaxItem> <maml:name>Set-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPoolUri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPoolUri</maml:name> <maml:description> <maml:para>The uris of the new set of target pools.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Abandon --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Abandon</maml:name> <maml:description> <maml:para>If set, will abandon the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Delete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Delete</maml:name> <maml:description> <maml:para>If set, will delete the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Recreate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Recreate</maml:name> <maml:description> <maml:para>If set, will recreate the instance specified by InstanceUri or InstanceObject.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceUri</maml:name> <maml:description> <maml:para>The uri of the instance to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance object to Abandon, Delete or Recreate.</maml:para> </maml:description> <command:parameterValue required="true">Instance[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Size --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Size</maml:name> <maml:description> <maml:para>The new target size of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Template --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Uri to the new template of the instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPoolUri --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPoolUri</maml:name> <maml:description> <maml:para>The uris of the new set of target pools.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The uri of the instance to Abandon, Delete or Recreate.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Instance[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Instance object to Abandon, Delete or Recreate.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: InstanceGroupManager --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceInstance "my-instance-1" | Set-ManagedInstanceGroup "my-group" -Abandon</dev:code> <dev:remarks> <maml:para>Abandons the instance named "my-instance-1". The instance will still exist, but will no longer be a member of the instance group "my-group". The size of the instance group will decrease to match.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $instanceUri = (Get-GceInstance "my-instance-2").SelfLink PS C:\> Set-ManagedInstanceGroup "my-group" -Delete -InstanceUri $instanceUri</dev:code> <dev:remarks> <maml:para>Deletes the instance "my-instance-2". The size of the instance group will decrease to match.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GceManagedInstanceGroup "my-group" -Size 5</dev:code> <dev:remarks> <maml:para>Changes the target size of managed instance group "my-group" to be 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> $template = Get-GceInstanceTemplate "new-template" PS C:\> Set-GceManagedInstanceGroup "my-group" -Template $template</dev:code> <dev:remarks> <maml:para>The tempalte "new-template" becomes the template for all new instances created by managed instance group "my-group"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managed Instance Group resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceGroupManagers#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Wait-GceManagedInstanceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Wait-GceManagedInstanceGroup</command:name> <command:verb>Wait</command:verb> <command:noun>GceManagedInstanceGroup</command:noun> <maml:description> <maml:para>Waits for a Google Compute Engine managed instance group to be stable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Waits for all of the instances of a managed instance group to reach normal running state.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Wait-GceManagedInstanceGroup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to wait on.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum number of seconds to wait for each managed instance group. -1, the default, waits until all instances have no current action, no matter how long it takes. If the timeout expires, the wait will end with a warning.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Wait-GceManagedInstanceGroup</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The mananged instance group object to wait on.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum number of seconds to wait for each managed instance group. -1, the default, waits until all instances have no current action, no matter how long it takes. If the timeout expires, the wait will end with a warning.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the managed instance group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the managed instance group is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the managed instance group to wait on.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The mananged instance group object to wait on.</maml:para> </maml:description> <command:parameterValue required="true">InstanceGroupManager</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The maximum number of seconds to wait for each managed instance group. -1, the default, waits until all instances have no current action, no matter how long it takes. If the timeout expires, the wait will end with a warning.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the managed instance group to wait on.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.InstanceGroupManager</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The mananged instance group object to wait on.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Wait-GceManagedInstanceGroup "my-group" -Timeout 30</dev:code> <dev:remarks> <maml:para>Waits for the managed instance group "my-group" to reach a noraml running state for up to 30 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceManagedInstanceGroup -Zone "us-central1-a" | Wait-GceManagedInstanceGroup</dev:code> <dev:remarks> <maml:para>Waits for all maanged instance groups in zone us-central1-a to reach a normal running state.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managed Instance Group resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instanceGroupManagers#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceMetadata --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceMetadata</command:name> <command:verb>Get</command:verb> <command:noun>GceMetadata</command:noun> <maml:description> <maml:para>Gets the current metadata from the metadata server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the current metadata from the metadata server. Get-GceMetadata can only be called from a Google Compute Engine VM instance. Calls from any other machine will fail.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GceMetadata</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the specific metadata you wish to get e.g. "instance/tags", "instance/attributes", "project/attributes/sshKeys".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If set, will get the metadata subtree as a JSON string. If -Path is not set, will get the entire metadata tree as a JSON string.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AppendETag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendETag</maml:name> <maml:description> <maml:para>When set, the value of the respone ETag will be appended to the output pipeline after the content.</maml:para> <maml:para>"$metadata, $etag = Get-GceMetadata -AppendETag -Recurse" gets the entire metadata tree, and the ETag of the version retrieved.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitUpdate</maml:name> <maml:description> <maml:para>If true, the query will wait for the metadata to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LastETag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastETag</maml:name> <maml:description> <maml:para>The last ETag known. Used in conjunction with -WaitUpdate. If the last ETag does not match the current ETag of the metadata server, it will return the updated value immediatly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Used in conjunction with -WaitUpdate. The amout of time to wait. If the timeout expires, the current metadata will be returned.</maml:para> <maml:para>Check the ETag using AppendEtag to see if the data was updated within the timeout period.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the specific metadata you wish to get e.g. "instance/tags", "instance/attributes", "project/attributes/sshKeys".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If set, will get the metadata subtree as a JSON string. If -Path is not set, will get the entire metadata tree as a JSON string.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AppendETag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppendETag</maml:name> <maml:description> <maml:para>When set, the value of the respone ETag will be appended to the output pipeline after the content.</maml:para> <maml:para>"$metadata, $etag = Get-GceMetadata -AppendETag -Recurse" gets the entire metadata tree, and the ETag of the version retrieved.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WaitUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitUpdate</maml:name> <maml:description> <maml:para>If true, the query will wait for the metadata to update.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LastETag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LastETag</maml:name> <maml:description> <maml:para>The last ETag known. Used in conjunction with -WaitUpdate. If the last ETag does not match the current ETag of the metadata server, it will return the updated value immediatly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Used in conjunction with -WaitUpdate. The amout of time to wait. If the timeout expires, the current metadata will be returned.</maml:para> <maml:para>Check the ETag using AppendEtag to see if the data was updated within the timeout period.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $allMetadata = Get-GceMetadata -Recurse | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Gets all of the metadata and converts it from the given JSON to a PSCustomObject.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $hostName = Get-GceMetadata -Path "instance/hostname"</dev:code> <dev:remarks> <maml:para>Gets the hostname of the instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $customProjectMetadata = Get-GceMetadata -Path "project/attributes/customKey"</dev:code> <dev:remarks> <maml:para>Gets the value of the custom metadata with key "customKey" placed in the project .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> $metadata, $etag = Get-GceMetadata -AppendETag -Recurse</dev:code> <dev:remarks> <maml:para>Gets the entire metadata tree, and the ETag of the version retrieved.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> $newTags, $newEtag = Get-GceMetadata -Path "instance/tags" -AppendETag -WaitUpdate ` -LastETag $oldETag</dev:code> <dev:remarks> <maml:para>Waits for the metadata "instance/tags" to be updated by the server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Metadata Documentation] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/storing-retrieving-metadata)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Metadata server documentation] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/storing-retrieving-metadata)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceNetwork</command:name> <command:verb>Get</command:verb> <command:noun>GceNetwork</command:noun> <maml:description> <maml:para>Get data about the networks a project has.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get data about the networks a project has. This includes its name, id, and subnetworks.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GceNetwork</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the networks of. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the networks to get.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the networks of. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the networks to get.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Network</maml:name> <maml:description> <maml:para>The names of the networks to get.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the networks to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Network --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Network</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceNetwork</dev:code> <dev:remarks> <maml:para>Lists all networks in set up for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceNetwork "default"</dev:code> <dev:remarks> <maml:para>Gets the default network for the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Network resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/networks#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GceNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceNetwork</command:name> <command:verb>New</command:verb> <command:noun>GceNetwork</command:noun> <maml:description> <maml:para>Creates a new Google Compute Engine network.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new Google Compute Engine network. The cmdlet will create the network in the default project if -Project is not used. By default, the network is created in without any subnets. To create a network with subnets automatically created, use -AutoSubnet switch. To create a network in legacy mode, which has a range and cannot have subnets, use the -IPv4Range parameter. Please note that using legacy network is not recommended as many newer Google Cloud Platform features are not supported on legacy networks and legacy networks may not be supported in the future.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GceNetwork</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the network in. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the network to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the network to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Range --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPv4Range</maml:name> <maml:description> <maml:para>The IPv4 range of the network. Please note that using this parameter will create a legacy network that has range and cannot have subnets. This is not recommended as many Google Cloud features are not available on legacy networks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoSubnet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoSubnet</maml:name> <maml:description> <maml:para>If set to true, the network created will its subnets created automatically.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the network in. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the network to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Network</maml:name> <maml:description> <maml:para>The name of the network to be created.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the network to be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Range --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPv4Range</maml:name> <maml:description> <maml:para>The IPv4 range of the network. Please note that using this parameter will create a legacy network that has range and cannot have subnets. This is not recommended as many Google Cloud features are not available on legacy networks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoSubnet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoSubnet</maml:name> <maml:description> <maml:para>If set to true, the network created will its subnets created automatically.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the network to be created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Network --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Network</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GceNetwork -Name "my-network"</dev:code> <dev:remarks> <maml:para>Creates network "my-network" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GceNetwork -Name "my-network" -Project "my-project" -AutoSubnet</dev:code> <dev:remarks> <maml:para>Creates a network "my-network" with auto subnet created in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GceNetwork -Name "my-network" -IPv4Range 192.168.0.0/16</dev:code> <dev:remarks> <maml:para>Creates a network "my-network" IPv4 range of 192.168.0.0/16.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Networks] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/vpc/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Legacy Networks] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/vpc/legacy)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceNetwork</command:name> <command:verb>Remove</command:verb> <command:noun>GceNetwork</command:noun> <maml:description> <maml:para>Removes Google Compute Engine networks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more Google Compute Engine networks. Will raise errors if the networks do not exist. The cmdlet will delete the networks in the default project if -Project is not used. The cmdlet accept either the names of the networks or network objects. If network objects are used, network names and project names are extracted from the objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceNetwork</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to remove the networks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the networks to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceNetwork</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network objects to be removed. Network's name and project will be extracted from the object.</maml:para> </maml:description> <command:parameterValue required="true">Network[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Network[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to remove the networks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the networks to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Network"> <maml:name>Network</maml:name> <maml:description> <maml:para>The names of the networks to be removed.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The network objects to be removed. Network's name and project will be extracted from the object.</maml:para> </maml:description> <command:parameterValue required="true">Network[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Network[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the networks to be removed.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Network[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The network objects to be removed. Network's name and project will be extracted from the object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceNetwork -Network "my-network"</dev:code> <dev:remarks> <maml:para>This command removes network "my-network" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GceNetwork -Network "my-network1", "my-network2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes 2 networks ("my-network1" and "my-network2") in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceNetwork "my-network1", "my-network2" | Remove-GceNetwork</dev:code> <dev:remarks> <maml:para>This command removes networks "my-network1" and "my-network2" in the default project by piping the network object to Remove-GceNetwork.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Networks] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/vpc/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceRoute</command:name> <command:verb>Add</command:verb> <command:noun>GceRoute</command:noun> <maml:description> <maml:para>Adds a new networking route.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new networking route.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromObject --> <command:syntaxItem> <maml:name>Add-GceRoute</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the route to. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An object describing a route to add.</maml:para> </maml:description> <command:parameterValue required="true">Route</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromValues --> <command:syntaxItem> <maml:name>Add-GceRoute</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the route to. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationIpRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationIpRange</maml:name> <maml:description> <maml:para>The destination range of outgoing packets that this route applies to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Network</maml:name> <maml:description> <maml:para>The network this route applies to. Can be either a URL, or a network object from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this route.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Instance tag(s) this route applies to. May only contain lowercase letters, dashes and numbers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopInstance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopInstance</maml:name> <maml:description> <maml:para>The instance that should handle matching packets. Can be either a URL, or an instance from Get-GceInstance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopIp</maml:name> <maml:description> <maml:para>The IP Address of an instance that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopVpnTunnel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopVpnTunnel</maml:name> <maml:description> <maml:para>The URL of a VPN Tunnel that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopInternetGateway --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopInternetGateway</maml:name> <maml:description> <maml:para>The URL to a gateway that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the route to. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>An object describing a route to add.</maml:para> </maml:description> <command:parameterValue required="true">Route</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route to add.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationIpRange --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationIpRange</maml:name> <maml:description> <maml:para>The destination range of outgoing packets that this route applies to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Network</maml:name> <maml:description> <maml:para>The network this route applies to. Can be either a URL, or a network object from Get-GceNetwork.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of this route.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Instance tag(s) this route applies to. May only contain lowercase letters, dashes and numbers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopInstance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopInstance</maml:name> <maml:description> <maml:para>The instance that should handle matching packets. Can be either a URL, or an instance from Get-GceInstance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopIp --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopIp</maml:name> <maml:description> <maml:para>The IP Address of an instance that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopVpnTunnel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopVpnTunnel</maml:name> <maml:description> <maml:para>The URL of a VPN Tunnel that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextHopInternetGateway --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextHopInternetGateway</maml:name> <maml:description> <maml:para>The URL to a gateway that should handle matching packets.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object describing a route to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Route --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Route resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/routes#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceRoute</command:name> <command:verb>Get</command:verb> <command:noun>GceRoute</command:noun> <maml:description> <maml:para>Gets or lists networking routes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all the networking routes for a project, or gets a specific one by project and name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GceRoute</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the route to get. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific route to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the route to get. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the specific route to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the specific route to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Route --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Route resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/routes#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceRoute --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceRoute</command:name> <command:verb>Remove</command:verb> <command:noun>GceRoute</command:noun> <maml:description> <maml:para>Deletes a networking route.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a networking route.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceRoute</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the route to delete. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceRoute</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The route object that describes the route to delete.</maml:para> </maml:description> <command:parameterValue required="true">Route</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the route to delete. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the route to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The route object that describes the route to delete.</maml:para> </maml:description> <command:parameterValue required="true">Route</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Route</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The route object that describes the route to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Route resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/routes#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GceServiceAccountConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GceServiceAccountConfig</command:name> <command:verb>New</command:verb> <command:noun>GceServiceAccountConfig</command:noun> <maml:description> <maml:para>Creates a new ServiceAccount object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new ServiceAccount object. These objects are used by New-GceInstanceConfig and Add-GceInstanceTemplate cmdlets to link to service accounts and define scopes. These scopes in turn let your instances access Google Cloud Platform resources. If no service account email is specified, the cmdlet will use the default service account email.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromScopeUris --> <command:syntaxItem> <maml:name>New-GceServiceAccountConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The cmdlet will use the default service account from this project if no email is given.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email of the service account to link to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScopeUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ScopeUri</maml:name> <maml:description> <maml:para>A uri of a scope to add to this service account. When added from the pipeline, all pipeline scopes will be added to a single ServiceAccount.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromFlags --> <command:syntaxItem> <maml:name>New-GceServiceAccountConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The cmdlet will use the default service account from this project if no email is given.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email of the service account to link to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScopeUri --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScopeUri</maml:name> <maml:description> <maml:para>A uri of a scope to add to this service account. When added from the pipeline, all pipeline scopes will be added to a single ServiceAccount.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BigQuery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQuery</maml:name> <maml:description> <maml:para>If set, adds the BigQuery scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BigtableAdmin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigtableAdmin</maml:name> <maml:description> <maml:para>The type of Bigtable Admin scope. Defaults to None. Also accepts Tables and Full</maml:para> <maml:para>Possible values: None, Tables, Full</maml:para> </maml:description> <command:parameterValue required="true">BigTableAdminEnum</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+BigTableAdminEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tables</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BigtableData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigtableData</maml:name> <maml:description> <maml:para>The type of Bigtable Data scope. Defaults to None. Also accepts Read and ReadWrite.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudDatastore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudDatastore</maml:name> <maml:description> <maml:para>If set, adds the Cloud Datastore scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CloudLogging --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudLogging</maml:name> <maml:description> <maml:para>The type of Cloud Logging API scope to add. Defaults to Write. Also accepts None, Read and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudMonitoring --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudMonitoring</maml:name> <maml:description> <maml:para>The type of Cloud Monitoring scope to add. Defaults to Write. Also accepts None, Read and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudPubSub --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudPubSub</maml:name> <maml:description> <maml:para>If set, adds the Cloud Pub/Sub scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CloudSQL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudSQL</maml:name> <maml:description> <maml:para>If set, adds the Cloud SQL scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Compute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Compute</maml:name> <maml:description> <maml:para>The value of the Compute scope to add. Defaults to None. Also accepts Read and ReadWrite.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ServiceControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceControl</maml:name> <maml:description> <maml:para>If true, adds the Service Control scope. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceManagement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceManagement</maml:name> <maml:description> <maml:para>If true, adds the Service Management scope. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Storage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The type of Storage scope to add. Defaults to Read. Also accepts None, Write, ReadWrite and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TaskQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskQueue</maml:name> <maml:description> <maml:para>If set, adds the Task queue scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserInfo</maml:name> <maml:description> <maml:para>If set, adds the User info scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The cmdlet will use the default service account from this project if no email is given.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email of the service account to link to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScopeUri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ScopeUri</maml:name> <maml:description> <maml:para>A uri of a scope to add to this service account. When added from the pipeline, all pipeline scopes will be added to a single ServiceAccount.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BigQuery --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQuery</maml:name> <maml:description> <maml:para>If set, adds the BigQuery scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BigtableAdmin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigtableAdmin</maml:name> <maml:description> <maml:para>The type of Bigtable Admin scope. Defaults to None. Also accepts Tables and Full</maml:para> <maml:para>Possible values: None, Tables, Full</maml:para> </maml:description> <command:parameterValue required="true">BigTableAdminEnum</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+BigTableAdminEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tables</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BigtableData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BigtableData</maml:name> <maml:description> <maml:para>The type of Bigtable Data scope. Defaults to None. Also accepts Read and ReadWrite.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudDatastore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudDatastore</maml:name> <maml:description> <maml:para>If set, adds the Cloud Datastore scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CloudLogging --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudLogging</maml:name> <maml:description> <maml:para>The type of Cloud Logging API scope to add. Defaults to Write. Also accepts None, Read and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudMonitoring --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudMonitoring</maml:name> <maml:description> <maml:para>The type of Cloud Monitoring scope to add. Defaults to Write. Also accepts None, Read and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CloudPubSub --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudPubSub</maml:name> <maml:description> <maml:para>If set, adds the Cloud Pub/Sub scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CloudSQL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloudSQL</maml:name> <maml:description> <maml:para>If set, adds the Cloud SQL scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Compute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Compute</maml:name> <maml:description> <maml:para>The value of the Compute scope to add. Defaults to None. Also accepts Read and ReadWrite.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ServiceControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceControl</maml:name> <maml:description> <maml:para>If true, adds the Service Control scope. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ServiceManagement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceManagement</maml:name> <maml:description> <maml:para>If true, adds the Service Management scope. Defaults to true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Storage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The type of Storage scope to add. Defaults to Read. Also accepts None, Write, ReadWrite and Full.</maml:para> <maml:para>Possible values: None, Read, Write, ReadWrite, Full</maml:para> </maml:description> <command:parameterValue required="true">ReadWrite</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.ComputeEngine.NewGceServiceAccountConfigCmdlet+ReadWrite</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: TaskQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskQueue</maml:name> <maml:description> <maml:para>If set, adds the Task queue scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserInfo</maml:name> <maml:description> <maml:para>If set, adds the User info scope.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The email of the service account to link to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A uri of a scope to add to this service account. When added from the pipeline, all pipeline scopes will be added to a single ServiceAccount.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceAccount --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GceServiceAccountConfig serviceaccount@gserviceaccount.com -BigQuery -BigtableData Read</dev:code> <dev:remarks> <maml:para>Creates a scope on the serviceaccount@gserviceaccount.com service account that can make BigQuery queries and read bigtable data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GceServiceAccountConfig -BigQuery -BigtableData Read</dev:code> <dev:remarks> <maml:para>Creates a scope on the default service account that can make BigQuery queries and read bigtable data.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/instances#resource)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Default Service Account email] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/access/service-accounts#compute_engine_default_service_account)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GceSnapshot --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GceSnapshot</command:name> <command:verb>Add</command:verb> <command:noun>GceSnapshot</command:noun> <maml:description> <maml:para>Creates a new disk snapshot.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new disk snapshot to backup the data of the disk.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromDisk --> <command:syntaxItem> <maml:name>Add-GceSnapshot</maml:name> <!-- Parameter: Disk --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Disk</maml:name> <maml:description> <maml:para>The disk object to create the snapshot from.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot. Defaults to <DiskName>-<Timestamp></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the snapshot.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromDiskName --> <command:syntaxItem> <maml:name>Add-GceSnapshot</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the disk. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the disk is in. Defaults to the gloud config zone.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The name of the disk to get a snapshot of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot. Defaults to <DiskName>-<Timestamp></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the snapshot.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Disk --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Disk</maml:name> <maml:description> <maml:para>The disk object to create the snapshot from.</maml:para> </maml:description> <command:parameterValue required="true">Disk</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project of the disk. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone the disk is in. Defaults to the gloud config zone.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The name of the disk to get a snapshot of.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot. Defaults to <DiskName>-<Timestamp></maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Human readable description of the snapshot.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Disk</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The disk object to create the snapshot from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Snapshot --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GceSnapshot "my-disk" -Name "my-snapshot" </dev:code> <dev:remarks> <maml:para>Creates a new disk snapshot from the disk named "my-disk" in the default project and zone. The name of the snapshot will be "my-snapshot".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceDisk "my-disk" | Add-GceSnapshot</dev:code> <dev:remarks> <maml:para>Creates a new disk snapshot from the disk named "my-disk". The name of the snapshot will start with "my-disk" and end with the utc date and time the snapshot was taken.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Snapshot resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/snapshots#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceSnapshot --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceSnapshot</command:name> <command:verb>Get</command:verb> <command:noun>GceSnapshot</command:noun> <maml:description> <maml:para>Gets information about a Google Compute Engine disk snapshots.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about a Google Compute Engine disk snapshots.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceSnapshot</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the snapshot. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the snapshot. Defaults to the gcloud config project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the snapshot to get.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Snapshot --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceSnapshot</dev:code> <dev:remarks> <maml:para>Lists all snapshot in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceSnapshot "my-snapshot"</dev:code> <dev:remarks> <maml:para>Gets the snapshot in the default project named "my-snapshot".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Snapshot resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/snapshots#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GceSnapshot --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GceSnapshot</command:name> <command:verb>Remove</command:verb> <command:noun>GceSnapshot</command:noun> <maml:description> <maml:para>Deletes Google Compute Engine disk snapshots.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes Google Compute Engine disk snapshots.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GceSnapshot</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that describes the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">Snapshot</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GceSnapshot</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that describes the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">Snapshot</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that owns the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the snapshot to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.Snapshot</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object that describes the snapshot to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GceSnapshot "my-snapshot"</dev:code> <dev:remarks> <maml:para>Deletes the snapshot named "my-snapshot" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceSnapshot "my-snapshot" | Remove-GceSnapshot</dev:code> <dev:remarks> <maml:para>Deletes the snapshot named "my-snapshot" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Snapshot resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/snapshots#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceTargetPool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceTargetPool</command:name> <command:verb>Get</command:verb> <command:noun>GceTargetPool</command:noun> <maml:description> <maml:para>Gets Google Compute Engine target pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command lists target pools of a project, or gets a specific one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceTargetPool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pools belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: OfRegion --> <command:syntaxItem> <maml:name>Get-GceTargetPool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pools belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceTargetPool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pools belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target pool to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pools belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the forwaring rule to get. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target pool to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: TargetPool --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetPool</dev:code> <dev:remarks> <maml:para>This command lists all target pools for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetPool -Region us-central1</dev:code> <dev:remarks> <maml:para>This command lists all target pools in region "us-central1" for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetPool "my-target-pool"</dev:code> <dev:remarks> <maml:para>This command gets the target pool named "my-target-pool" in the default project and zone</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Target Pool resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/targetPools#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GceTargetPool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GceTargetPool</command:name> <command:verb>Set</command:verb> <command:noun>GceTargetPool</command:noun> <maml:description> <maml:para>Sets data about Google Compute Engine target pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-GceTargetPool adds and removes instance to and from target pools</maml:para> </maml:description> <command:syntax> <!-- Parameter set: RemoveInstanceByName --> <command:syntaxItem> <maml:name>Set-GceTargetPool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pool belongs to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the target pool. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target pool to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveInstance</maml:name> <maml:description> <maml:para>A list of instance to remove from the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddInstanceByName --> <command:syntaxItem> <maml:name>Set-GceTargetPool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pool belongs to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the target pool. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target pool to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddInstance</maml:name> <maml:description> <maml:para>A list of instance to add to the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RemoveInstanceByObject --> <command:syntaxItem> <maml:name>Set-GceTargetPool</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The target pool object to change.</maml:para> </maml:description> <command:parameterValue required="true">TargetPool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveInstance</maml:name> <maml:description> <maml:para>A list of instance to remove from the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddInstanceByObject --> <command:syntaxItem> <maml:name>Set-GceTargetPool</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The target pool object to change.</maml:para> </maml:description> <command:parameterValue required="true">TargetPool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddInstance</maml:name> <maml:description> <maml:para>A list of instance to add to the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target pool belongs to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The region of the target pool. Defaults to the region in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target pool to change.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The target pool object to change.</maml:para> </maml:description> <command:parameterValue required="true">TargetPool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddInstance</maml:name> <maml:description> <maml:para>A list of instance to add to the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveInstance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveInstance</maml:name> <maml:description> <maml:para>A list of instance to remove from the target pool. Can take either string urls or Google.Apis.Compute.v1.Data.Instance objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The target pool object to change.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TargetPool --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetPool</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $instance = Get-GceInstance "my-instance" PS C:\> Get-GceTargetPool "my-pool" | Set-GceTargetPool -AddInstance $instance</dev:code> <dev:remarks> <maml:para>This command adds instance "my-instance" to the target pool "my-pool"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GceTargetPool "my-pool" -RemoveInstance $instanceUrl</dev:code> <dev:remarks> <maml:para>This command removes the instance pointed to by $instanceUrl from target pool "my-pool".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Target Pool resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/targetPools#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceTargetProxy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceTargetProxy</command:name> <command:verb>Get</command:verb> <command:noun>GceTargetProxy</command:noun> <maml:description> <maml:para>Gets Google Compute Engine target proxies.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists target proxies of a project, or gets a specific one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceTargetProxy</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target proxies belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will get target http proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will get target https proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceTargetProxy</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target proxies belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target proxy to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will get target http proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will get target https proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the target proxies belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target proxy to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Http --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Http</maml:name> <maml:description> <maml:para>If set, will get target http proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Https --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Https</maml:name> <maml:description> <maml:para>If set, will get target https proxies. If neither this nor Https is set, will get both http and https proxies.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: TargetHttpProxy --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetHttpProxy</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TargetHttpsProxy --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.TargetHttpsProxy</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetProxy</dev:code> <dev:remarks> <maml:para>This command lists all target proxies for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetProxy -Region us-central1</dev:code> <dev:remarks> <maml:para>This command lists all target proxies in region "us-central1" for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GceTargetProxy "my-target-proxy"</dev:code> <dev:remarks> <maml:para>This command gets the target proxy named "my-target-proxy" in the default project and zone</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Target Proxy resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GceUrlMap --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GceUrlMap</command:name> <command:verb>Get</command:verb> <command:noun>GceUrlMap</command:noun> <maml:description> <maml:para>Gets Google Compute Engine url maps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists url maps of a project, or gets a specific one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OfProject --> <command:syntaxItem> <maml:name>Get-GceUrlMap</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the url maps belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GceUrlMap</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the url maps belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the url map to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project the url maps belong to. Defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the url map to get.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: UrlMap --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.UrlMap</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GceUrlMap</dev:code> <dev:remarks> <maml:para>This command lists all url maps for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GceUrlMap "my-url-map"</dev:code> <dev:remarks> <maml:para>This command gets the url map named "my-url-map"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Url Map resource definition] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/reference/latest/urlMaps#resource)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GcIamPolicyBinding --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcIamPolicyBinding</command:name> <command:verb>Add</command:verb> <command:noun>GcIamPolicyBinding</command:noun> <maml:description> <maml:para>Adds an IAM policy binding to a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds an IAM policy binding to a project. The cmdlet will use the default project if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Add-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Email address that represents a specific Google account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ServiceAccount --> <command:syntaxItem> <maml:name>Add-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Email address that represents a service account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Add-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Email address that represents a Google group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Add-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>A Google Apps domain name that represents all the users of that domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Email address that represents a specific Google account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Email address that represents a service account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Email address that represents a Google group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>A Google Apps domain name that represents all the users of that domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcIamPolicyBinding -Role roles/owner -User abc@google.com -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command gives user abc@google.com owner role in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GcIamPolicyBinding -Role roles/container.admin -Group my-group@google.com</dev:code> <dev:remarks> <maml:para>This command gives the group my-group@google.com container admin role in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GcIamPolicyBinding -Role roles/container.admin ` -ServiceAccount service@project.iam.gserviceaccount.com</dev:code> <dev:remarks> <maml:para>This command gives the serviceaccount service@project.iam.gserviceaccount.com container admin role in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Add-GcIamPolicyBinding -Role roles/editor -Domain example.com</dev:code> <dev:remarks> <maml:para>This command gives all users of the domain example.com editor role in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Google Cloud IAM] </maml:linkText> <maml:uri>(https://cloud.google.com/iam/docs/overview)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcIamPolicyBinding --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcIamPolicyBinding</command:name> <command:verb>Get</command:verb> <command:noun>GcIamPolicyBinding</command:noun> <maml:description> <maml:para>Lists all IAM policy bindings in a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all IAM policy bindings in a project. The cmdlet will use the default project if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for IAM Policies. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for IAM Policies. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcIamPolicyBinding</dev:code> <dev:remarks> <maml:para>This command gets all the IAM policy bindings from the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Google Cloud IAM] </maml:linkText> <maml:uri>(https://cloud.google.com/iam/docs/overview)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcIamPolicyBinding --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcIamPolicyBinding</command:name> <command:verb>Remove</command:verb> <command:noun>GcIamPolicyBinding</command:noun> <maml:description> <maml:para>Removes an IAM policy binding to a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an IAM policy binding to a project. The cmdlet will use the default project if -Project is not used. If the binding does not exist, the cmdlet will not raise error.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Remove-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Email address that represents a specific Google account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ServiceAccount --> <command:syntaxItem> <maml:name>Remove-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Email address that represents a service account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Remove-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Email address that represents a Google group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Remove-GcIamPolicyBinding</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>A Google Apps domain name that represents all the users of that domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project for the IAM Policy Bindings. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>Email address that represents a specific Google account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Email address that represents a service account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>Email address that represents a Google group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>A Google Apps domain name that represents all the users of that domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcIamPolicyBinding -Role roles/owner -User abc@google.com -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes the owner role of user abc@google.com in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcIamPolicyBinding -Role roles/container.admin -Group my-group@google.com</dev:code> <dev:remarks> <maml:para>This command removes the container admin role of the group my-group@google.com in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcIamPolicyBinding -Role roles/container.admin ` -ServiceAccount service@project.iam.gserviceaccount.com</dev:code> <dev:remarks> <maml:para>This command removes the container admin role of the serviceaccount service@project.iam.gserviceaccount.com in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Remove-GcIamPolicyBinding -Role roles/editor -Domain example.com</dev:code> <dev:remarks> <maml:para>This command removes the editor role of all users of the domain example.com in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Google Cloud IAM] </maml:linkText> <maml:uri>(https://cloud.google.com/iam/docs/overview)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcLog</command:name> <command:verb>Get</command:verb> <command:noun>GcLog</command:noun> <maml:description> <maml:para>Lists Stackdriver logs' names from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists Stackdriver logs' names from a project. Will display logs' names from the default project if -Project is not used. A log is a named collection of log entries within the project (any log mus thave at least 1 log entry). To get log entries from a particular log, use Get-GcLogEntry cmdlet instead.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcLog</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for logs in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for logs in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcLog</dev:code> <dev:remarks> <maml:para>This command gets logs from the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcLog -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command gets logs from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/basic-concepts#logs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcLog --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcLog</command:name> <command:verb>Remove</command:verb> <command:noun>GcLog</command:noun> <maml:description> <maml:para>Removes one or more Stackdriver logs from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more StackDrive logs from a project based on the names of the logs. All the entries in the logs will be deleted (a log have multiple log entries).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcLog</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log entries. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The names of the logs to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log entries. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The names of the logs to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the logs to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcLog -LogName "test-log"</dev:code> <dev:remarks> <maml:para>This command removes "test-log" from the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcLog -LogName "test-log" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes "test-log" from project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcLog -LogName "log1", "log2"</dev:code> <dev:remarks> <maml:para>This command removes "log1" and "log2" from the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Entries and Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_index)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcLogEntry --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcLogEntry</command:name> <command:verb>Get</command:verb> <command:noun>GcLogEntry</command:noun> <maml:description> <maml:para>Gets log entries.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all log entries from a project or gets the entries from a specific log. Log entries can be filtered using -LogName, -Severity, -After or -Before parameter. For advanced filtering, please use -Filter parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcLogEntry</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log entries. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log entries. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: LogEntry --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Logging.v2.Data.LogEntry</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry</dev:code> <dev:remarks> <maml:para>This command gets all the log entries for the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command gets all the log entries from the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -LogName "my-log"</dev:code> <dev:remarks> <maml:para>This command gets all the log entries from the log named "my-backendservice".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -LogName "my-log"</dev:code> <dev:remarks> <maml:para>This command gets all the log entries from the log named "my-backendservice".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -LogName "my-log" -Severity Error</dev:code> <dev:remarks> <maml:para>This command gets all the log entries with severity ERROR from the log named "my-backendservice".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -LogName "my-log" -Before [DateTime]::Now.AddMinutes(30)</dev:code> <dev:remarks> <maml:para>This command gets all the log entries from the log named "my-backendservice" created before 30 minutes ago.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -LogName "my-log" -After [DateTime]::Now.AddMinutes(30)</dev:code> <dev:remarks> <maml:para>This command gets all the log entries from the log named "my-backendservice" created after 30 minutes ago.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>PS C:\> Get-GcLogEntry -Filter 'resource.type="gce_instance" AND severity >= ERROR'</dev:code> <dev:remarks> <maml:para>This command gets all the log entries that satisfy filter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Entries and Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_index)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Logs Filters] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/advanced_filters)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcLogEntry --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcLogEntry</command:name> <command:verb>New</command:verb> <command:noun>GcLogEntry</command:noun> <maml:description> <maml:para>Creates new log entries.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates new log entries in a log. The cmdlet will create the log if it doesn't exist. By default, the log is associated with the "global" resource type ("custom.googleapis.com" in v1 service).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: TextPayload --> <command:syntaxItem> <maml:name>New-GcLogEntry</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to where the log entry will be written to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the log that this entry will be written to. If the log does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TextPayload --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TextPayload</maml:name> <maml:description> <maml:para>The text payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the log entry. Default value is Default.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitoredResource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoredResource</maml:name> <maml:description> <maml:para>Monitored Resource associated with the log. If not provided, we will default to "global" resource type ("custom.googleapis.com" in v1 service). This is what gcloud beta logging write uses. This indicates that the log is not associated with any specific resource. More information can be found at https://cloud.google.com/logging/docs/api/v2/resource-list</maml:para> </maml:description> <command:parameterValue required="true">MonitoredResource</command:parameterValue> <dev:type> <maml:name>Google.Apis.Logging.v2.Data.MonitoredResource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: JsonPayload --> <command:syntaxItem> <maml:name>New-GcLogEntry</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to where the log entry will be written to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the log that this entry will be written to. If the log does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JsonPayload --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>JsonPayload</maml:name> <maml:description> <maml:para>The JSON payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the log entry. Default value is Default.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitoredResource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoredResource</maml:name> <maml:description> <maml:para>Monitored Resource associated with the log. If not provided, we will default to "global" resource type ("custom.googleapis.com" in v1 service). This is what gcloud beta logging write uses. This indicates that the log is not associated with any specific resource. More information can be found at https://cloud.google.com/logging/docs/api/v2/resource-list</maml:para> </maml:description> <command:parameterValue required="true">MonitoredResource</command:parameterValue> <dev:type> <maml:name>Google.Apis.Logging.v2.Data.MonitoredResource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ProtoPayload --> <command:syntaxItem> <maml:name>New-GcLogEntry</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to where the log entry will be written to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the log that this entry will be written to. If the log does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtoPayload --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtoPayload</maml:name> <maml:description> <maml:para>The proto payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the log entry. Default value is Default.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitoredResource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoredResource</maml:name> <maml:description> <maml:para>Monitored Resource associated with the log. If not provided, we will default to "global" resource type ("custom.googleapis.com" in v1 service). This is what gcloud beta logging write uses. This indicates that the log is not associated with any specific resource. More information can be found at https://cloud.google.com/logging/docs/api/v2/resource-list</maml:para> </maml:description> <command:parameterValue required="true">MonitoredResource</command:parameterValue> <dev:type> <maml:name>Google.Apis.Logging.v2.Data.MonitoredResource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to where the log entry will be written to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogName</maml:name> <maml:description> <maml:para>The name of the log that this entry will be written to. If the log does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TextPayload --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>TextPayload</maml:name> <maml:description> <maml:para>The text payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JsonPayload --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>JsonPayload</maml:name> <maml:description> <maml:para>The JSON payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProtoPayload --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtoPayload</maml:name> <maml:description> <maml:para>The proto payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>The severity of the log entry. Default value is Default.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitoredResource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoredResource</maml:name> <maml:description> <maml:para>Monitored Resource associated with the log. If not provided, we will default to "global" resource type ("custom.googleapis.com" in v1 service). This is what gcloud beta logging write uses. This indicates that the log is not associated with any specific resource. More information can be found at https://cloud.google.com/logging/docs/api/v2/resource-list</maml:para> </maml:description> <command:parameterValue required="true">MonitoredResource</command:parameterValue> <dev:type> <maml:name>Google.Apis.Logging.v2.Data.MonitoredResource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The text payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The JSON payload of the log entry. Each value in the array will be written to a single entry in the log.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcLogEntry -TextPayload "This is a log entry." -LogName "test-log"</dev:code> <dev:remarks> <maml:para>This command creates a log entry with the specified text payload in the log "test-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcLogEntry -TextPayload "Entry 1", "Entry 2" -LogName "test-log"</dev:code> <dev:remarks> <maml:para>This command creates 2 log entries with text payload "Entry 1" and "Entry 2" respectively in the log "test-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GcLogEntry -JsonPayload @{"a" = "b"} -LogName "test-log" -Severity Error</dev:code> <dev:remarks> <maml:para>This command creates a log entry with a json payload and severity level Error in the log "test-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> New-GcLogEntry -MonitoredResource (New-GcLogMonitoredResource -ResourceType global -Labels @{"project_id" = "my-project"}) ` -TextPayload "This is a log entry."</dev:code> <dev:remarks> <maml:para>This command creates a log entry directly from the LogEntry object. The command also associates it with a resource type created from New-GcLogMonitoredResource</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Entries and Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_index)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Monitored Resources] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/api/v2/resource-list)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcLogMetric --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcLogMetric</command:name> <command:verb>Get</command:verb> <command:noun>GcLogMetric</command:noun> <maml:description> <maml:para>Retrieves StackDriver Log Metrics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves one or more StackDriver Log Metrics. If -MetricName is not used, the cmdlet will return all the log metrics under the specified project (default project if -Project is not used). Otherwise, the cmdlet will return a list of metrics matching the names specified in -MetricName and will raise an error for any metrics that cannot be found.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcLogMetric</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The names of the log metrics to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The names of the log metrics to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the log metrics to be retrieved.</maml:para> <maml:para>This is an alias of the MetricName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcLogMetric</dev:code> <dev:remarks> <maml:para>This command retrieves all metrics in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcLogMetric -MetricName "metric1", "metric2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command retrieves 2 metrics ("metric1" and "metric2") in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Metrics] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_based_metrics)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcLogMetric --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcLogMetric</command:name> <command:verb>New</command:verb> <command:noun>GcLogMetric</command:noun> <maml:description> <maml:para>Creates a new log metric.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new log metric. The metric will be created in the default project if -Project is not used. Will raise an error if the metric already exists.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcLogMetric</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The name of the metric. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the metric.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The name of the metric. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the metric.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcLogMetric -MetricName "my-metric" -LogName "my-log"</dev:code> <dev:remarks> <maml:para>This command creates a metric to count the number of log entries in log "my-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcLogMetric -MetricName "my-metric" ` -ResourceType "gce_instance" -After [DateTime]::Now().AddDays(1) -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command creates a metric name "my-metric" in project "my-project" that counts every log entry of the resource type "gce_instance" that is created from tomorrow.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GcLogMetric -MetricName "my-metric" -Filter 'textPayload = "textPayload"'</dev:code> <dev:remarks> <maml:para>This command creates a metric name "my-metric" that counts every log entry that matches the provided filter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Metrics] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_based_metrics)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcLogMetric --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcLogMetric</command:name> <command:verb>Remove</command:verb> <command:noun>GcLogMetric</command:noun> <maml:description> <maml:para>Removes one or more log metrics from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more log metrics from a project based on the name of the metrics. If -Project is not specified, the default project will be used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcLogMetric</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The names of the metrics to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The names of the metrics to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the metrics to be removed.</maml:para> <maml:para>This is an alias of the MetricName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the metrics to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcLogMetric -MetricName "my-metric"</dev:code> <dev:remarks> <maml:para>This command removes "my-metric" from the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcLogMetric -MetricName "my-metric", "my-metric2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes "my-metric" and "my-metric2" from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Metrics] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_based_metrics)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GcLogMetric --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GcLogMetric</command:name> <command:verb>Set</command:verb> <command:noun>GcLogMetric</command:noun> <maml:description> <maml:para>Updates a log metric.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a log metric. The cmdlet will create the metric if it does not exist. The default project will be used to search for the metric if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-GcLogMetric</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The name of the metric. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the metric.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the metrics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetricName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MetricName</maml:name> <maml:description> <maml:para>The name of the metric. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the metric.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GcLogMetric -MetricName "my-metric" -LogName "my-log"</dev:code> <dev:remarks> <maml:para>This command updates the metric "my-metric" to count the number of log entries in log "my-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GcLogMetric -MetricName "my-metric" ` -ResourceType "gce_instance" -After [DateTime]::Now().AddDays(1) -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command updates the metric name "my-metric" in project "my-project" to count every log entry of the resource type "gce_instance" that is created from tomorrow.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GcLogMetric -MetricName "my-metric" -Filter 'textPayload = "textPayload"'</dev:code> <dev:remarks> <maml:para>This command updates the metric name "my-metric" to count every log entry that matches the provided filter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Metrics] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/view/logs_based_metrics)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcLogMonitoredResource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcLogMonitoredResource</command:name> <command:verb>New</command:verb> <command:noun>GcLogMonitoredResource</command:noun> <maml:description> <maml:para>Creates new monitored resources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates new monitored resources. These resources are used in the Logging cmdlets such as New-GcLogEntry</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcLogMonitoredResource</maml:name> <!-- Parameter: Labels --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Labels</maml:name> <maml:description> <maml:para>The label that applies to resource type. For a complete list, see https://cloud.google.com/logging/docs/api/v2/resource-list.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Labels --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Labels</maml:name> <maml:description> <maml:para>The label that applies to resource type. For a complete list, see https://cloud.google.com/logging/docs/api/v2/resource-list.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcLogMonitoredResource -ResourceType "gce_instance" ` -Labels @{"project_id" = "my-project"; "instance_id" = "my-instance"}.</dev:code> <dev:remarks> <maml:para>This command creates a new monitored resource of type "gce_instance" with specified labels.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Monitored Resources and Labels] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/api/v2/resource-list)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcLogSink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcLogSink</command:name> <command:verb>Get</command:verb> <command:noun>GcLogSink</command:noun> <maml:description> <maml:para>Retrieves Stackdriver Log Sinks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves one or more Stackdriver Log Sinks. If -Sink is not used, the cmdlet will return all the sinks under the specified project (default project if -Project is not used). Otherwise, the cmdlet will return a list of sinks matching the sink names specified in -Sink and will raise an error for any sinks that cannot be found.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcLogSink</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for sinks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sink --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Sink</maml:name> <maml:description> <maml:para>The names of the sinks to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for sinks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sink --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Sink</maml:name> <maml:description> <maml:para>The names of the sinks to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the sinks to be retrieved.</maml:para> <maml:para>This is an alias of the Sink parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcLogSink</dev:code> <dev:remarks> <maml:para>This command retrieves all sinks in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcLogSink -Sink "sink1", "sink2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command retrieves 2 sinks ("sink1" and "sink2") in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Sinks] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/api/tasks/exporting-logs#about_sinks)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcLogSink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcLogSink</command:name> <command:verb>New</command:verb> <command:noun>GcLogSink</command:noun> <maml:description> <maml:para>Creates a new log sink.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new log sink to export log entries. The sink will be created in the default project if -Project is not used. Will raise an error if the sink already exists. There are 3 possible destinations for the sink: Google Cloud Storage bucket, Google BigQuery dataset and Google Cloud PubSub topic. The destinations must be created and given appropriate permissions for log exporting (see https://cloud.google.com/logging/docs/export/configure_export_v2#destination_authorization) The cmdlet will not create the destinations. The identity of the writer of the logs will be cloud-logs@system.gserviceaccount.com by default if -UniqueWriterIdentity is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: GcsBucketDestination --> <command:syntaxItem> <maml:name>New-GcLogSink</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GcsBucketDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GcsBucketDestination</maml:name> <maml:description> <maml:para>The name of the Google Cloud Storage bucket that the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the new sink. If this value is not provided, then the value returned as writerIdentity is cloud-logs@google.com. Otherwise, it will be a unique service account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BigQueryDataSetDestination --> <command:syntaxItem> <maml:name>New-GcLogSink</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BigQueryDataSetDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQueryDataSetDestination</maml:name> <maml:description> <maml:para>The name of the Google BigQuery dataset that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the new sink. If this value is not provided, then the value returned as writerIdentity is cloud-logs@google.com. Otherwise, it will be a unique service account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PubSubTopicDestination --> <command:syntaxItem> <maml:name>New-GcLogSink</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PubSubTopicDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PubSubTopicDestination</maml:name> <maml:description> <maml:para>The name of the Google PubSub topic that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the new sink. If this value is not provided, then the value returned as writerIdentity is cloud-logs@google.com. Otherwise, it will be a unique service account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GcsBucketDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GcsBucketDestination</maml:name> <maml:description> <maml:para>The name of the Google Cloud Storage bucket that the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BigQueryDataSetDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQueryDataSetDestination</maml:name> <maml:description> <maml:para>The name of the Google BigQuery dataset that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PubSubTopicDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PubSubTopicDestination</maml:name> <maml:description> <maml:para>The name of the Google PubSub topic that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the new sink. If this value is not provided, then the value returned as writerIdentity is cloud-logs@google.com. Otherwise, it will be a unique service account.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcLogSink -SinkName "my-sink" -GcsBucketDestination "my-bucket"</dev:code> <dev:remarks> <maml:para>This command creates a sink name "my-sink" that exports every log entry in the default project to the Google Cloud Storage bucket "my-bucket". The identity of the writer of the logs will be cloud-logs@system.gserviceaccount.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcLogSink -SinkName "my-sink" -BigQueryDataSetDestination "my_dataset" -LogName "my-log" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command creates a sink name "my-sink" that exports every log entry in the log "my-log" in the project "my-project" to the Google Cloud BigQuery dataset "my_dataset" (also in the project "my-project"). The identity of the writer of the logs will be cloud-logs@system.gserviceaccount.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GcLogSink -SinkName "my-sink" -PubSubTopicDestination "my_dataset" -Filter 'textPayload = "textPayload"' -UniqueWriterIdentity</dev:code> <dev:remarks> <maml:para>This command creates a sink name "my-sink" that exports every log entry that matches the provided filter to the Google Cloud PubSub topic "my-topic". The identity of the writer of the logs will be a unique service account.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Sinks] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/basic-concepts#sinks)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Exporting Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/export/using_exported_logs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcLogSink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcLogSink</command:name> <command:verb>Remove</command:verb> <command:noun>GcLogSink</command:noun> <maml:description> <maml:para>Removes one or more log sinks from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more log sinks from a project based on the name of the log. If -Project is not specified, the default project will be used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcLogSink</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log sinks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The names of the sinks to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for log sinks in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The names of the sinks to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the sinks to be removed.</maml:para> <maml:para>This is an alias of the SinkName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the sinks to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcLogSink -SinkName "my-sink"</dev:code> <dev:remarks> <maml:para>This command removes "my-sink" from the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcLogSink -SinkName "my-sink", "my-sink2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes "my-sink" and "my-sink2" from project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Sinks] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/export/using_exported_logs#sink-service-destination)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GcLogSink --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GcLogSink</command:name> <command:verb>Set</command:verb> <command:noun>GcLogSink</command:noun> <maml:description> <maml:para>Updates properties of a log sink. If the sink does not exist, the cmdlet will create the sink.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates properties of a log sink. If the sink does not exist, the cmdlet will create the sink. The cmdlet will use the default project if -Project is not used.</maml:para> <maml:para>There are 3 possible destinations for the sink: Google Cloud Storage bucket, Google BigQuery dataset and Google Cloud PubSub topic. The destinations must be created and given appropriate permissions for log exporting (see https://cloud.google.com/logging/docs/export/configure_export_v2#destination_authorization) The cmdlet will not create the destinations.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: GcsBucketDestination --> <command:syntaxItem> <maml:name>Set-GcLogSink</maml:name> <!-- Parameter: GcsBucketDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GcsBucketDestination</maml:name> <maml:description> <maml:para>The name of the Google Cloud Storage bucket that the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the sink. If previously, the sink's writer identity is cloud-logs service account, then the writer identity of the sink will now be changed to a unique service account. If the sink already has a unique writer identity, then this has no effect. Note that if the old sink has a unique writer identity, it will be an error to set this to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BigQueryDataSetDestination --> <command:syntaxItem> <maml:name>Set-GcLogSink</maml:name> <!-- Parameter: BigQueryDataSetDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQueryDataSetDestination</maml:name> <maml:description> <maml:para>The name of the Google BigQuery dataset that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the sink. If previously, the sink's writer identity is cloud-logs service account, then the writer identity of the sink will now be changed to a unique service account. If the sink already has a unique writer identity, then this has no effect. Note that if the old sink has a unique writer identity, it will be an error to set this to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PubSubTopicDestination --> <command:syntaxItem> <maml:name>Set-GcLogSink</maml:name> <!-- Parameter: PubSubTopicDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PubSubTopicDestination</maml:name> <maml:description> <maml:para>The name of the Google PubSub topic that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the sink. If previously, the sink's writer identity is cloud-logs service account, then the writer identity of the sink will now be changed to a unique service account. If the sink already has a unique writer identity, then this has no effect. Note that if the old sink has a unique writer identity, it will be an error to set this to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GcsBucketDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GcsBucketDestination</maml:name> <maml:description> <maml:para>The name of the Google Cloud Storage bucket that the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BigQueryDataSetDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BigQueryDataSetDestination</maml:name> <maml:description> <maml:para>The name of the Google BigQuery dataset that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PubSubTopicDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PubSubTopicDestination</maml:name> <maml:description> <maml:para>The name of the Google PubSub topic that the the sink will export the log entries to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueWriterIdentity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UniqueWriterIdentity</maml:name> <maml:description> <maml:para>Determines the kind of IAM identity returned as writerIdentity in the sink. If previously, the sink's writer identity is cloud-logs service account, then the writer identity of the sink will now be changed to a unique service account. If the sink already has a unique writer identity, then this has no effect. Note that if the old sink has a unique writer identity, it will be an error to set this to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the sink in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SinkName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SinkName</maml:name> <maml:description> <maml:para>The name of the sink to be created. This name must be unique within the project.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogName</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that are in the log LogName.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Severity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries with the specified severity.</maml:para> <maml:para>Possible values: Default, Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency</maml:para> </maml:description> <command:parameterValue required="true">LogSeverity</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Logging.GcLogCmdlet+LogSeverity</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Notice</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Alert</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emergency</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur before this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that occur after this datetime.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>If specified, the cmdlet will filter out log entries that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GcLogSink -SinkName "my-sink" -GcsBucketDestination "my-bucket"</dev:code> <dev:remarks> <maml:para>This command changes the destination of the sink name "my-sink" in the default project to "my-bucket".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GcLogSink -SinkName "my-sink" -BigQueryDataSetDestination "my_dataset" -LogName "my-log" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command changes the destination of the sink name "my-sink" in the project "my-project" to the big query dataset "my_dataset". The sink will now only export log from "my-log".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GcLogSink -SinkName "my-sink" -Filter 'textPayload = "textPayload"' -UniqueWriterIdentity</dev:code> <dev:remarks> <maml:para>This command updates the filter of the log sink "my-sink" to 'textPayload = "textPayload"' and updates the writer identity of the log sink to a unique service account.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Log Sinks] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/basic-concepts#sinks)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Exporting Logs] </maml:linkText> <maml:uri>(https://cloud.google.com/logging/docs/export/using_exported_logs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcpProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcpProject</command:name> <command:verb>Get</command:verb> <command:noun>GcpProject</command:noun> <maml:description> <maml:para>Retrieves one or more Google Cloud projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves one or more Google Cloud projects. The cmdlet will return all available projects if no parameter is used. If -Name, -Id or -Label is used, the cmdlets will return the projects that match the given arguments.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcpProject</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to seach for. This parameter is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The Id of the project to seach for. This parameter is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The labels of the project to seach for. Key and value of the label should be in lower case with no spaces in them.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to seach for. This parameter is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The Id of the project to seach for. This parameter is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The labels of the project to seach for. Key and value of the label should be in lower case with no spaces in them.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcProject</dev:code> <dev:remarks> <maml:para>This command gets all the available Google Cloud projects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcProject -Name "My Project"</dev:code> <dev:remarks> <maml:para>This command gets the project that has the name "My Project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcProject -Id "my-id"</dev:code> <dev:remarks> <maml:para>This command gets the project that has the Id "my-id".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GcProject -Label @{"environment" = "test"}</dev:code> <dev:remarks> <maml:para>This command gets all the projects that has the label "environment" with value "test".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Projects] </maml:linkText> <maml:uri>(https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy#cloud_platform_projects)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Labels] </maml:linkText> <maml:uri>(https://cloud.google.com/resource-manager/docs/using-labels)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Send-GcpsAck --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-GcpsAck</command:name> <command:verb>Send</command:verb> <command:noun>GcpsAck</command:noun> <maml:description> <maml:para>Sends acknowledgement for one or more PubSub messages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends acknowledgement for one or more PubSub messages. Will raise errors if the subscription that the messages are pulled from does not exist. The cmdlet will search for the subscription and the messages in the default project if -Project is not used. To send acknowledgement for messages from a single subscription, use -Subscription to provide the name of the subscription and -AckId to provide a list of Ack Ids for that subscription. To send acknowledgement for messages objects returned by Get-GcpsMessage cmdlet, use the -InputObject parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Send-GcpsAck</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AckId</maml:name> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Send-GcpsAck</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> <command:parameterValue required="true">PubSubMessageWithAckIdAndSubscription[]</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AckId</maml:name> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> <command:parameterValue required="true">PubSubMessageWithAckIdAndSubscription[]</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Send-GcpsAck -Subscription "my-subscription" -AckId "ackId"</dev:code> <dev:remarks> <maml:para>This command sends acknowledgement for message with Ack Id "ackId" from subscription "my-subscription" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Send-GcpsAck -Subscription "my-subscription" -AckId "ackId1", "ackId2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command sends acknowledgement for messages with Ack Ids "ackId1" and "ackId2" from subscription"my-subscription" in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $messages = Get-GcpsMessage -Subscription "my-subscription" PS C:\> Send-GcpsAck -InputObject $messages</dev:code> <dev:remarks> <maml:para>This command sends acknowledgement for messages pulled from subscription "my-subscription"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Receiving and Sending Acknowledge for Pull Messages] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#receiving-pull-messages)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GcpsAckDeadline --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GcpsAckDeadline</command:name> <command:verb>Set</command:verb> <command:noun>GcpsAckDeadline</command:noun> <maml:description> <maml:para>Setting acknowledgement deadline in seconds for one or more PubSub messages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Setting acknowledgement deadline in seconds for one or more PubSub messages. Will raise errors if the subscription that the messages are pulled from does not exist. The cmdlet will search for the subscription and the messages in the default project if -Project is not used. To set the acknowledgement deadline for messages from a single subscription, use -Subscription to provide the name of the subscription and -AckId to provide a list of Ack Ids for that subscription. To send acknowledgement for messages objects returned by Get-GcpsMessage cmdlet, use the -InputObject parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Set-GcpsAckDeadline</maml:name> <!-- Parameter: AckDeadline --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AckDeadline</maml:name> <maml:description> <maml:para>The ack deadline to be set (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AckId</maml:name> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Set-GcpsAckDeadline</maml:name> <!-- Parameter: AckDeadline --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AckDeadline</maml:name> <maml:description> <maml:para>The ack deadline to be set (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> <command:parameterValue required="true">PubSubMessageWithAckIdAndSubscription[]</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AckDeadline --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AckDeadline</maml:name> <maml:description> <maml:para>The ack deadline to be set (in seconds).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription that the messages are pulled from. This parameter is used with -AckId parameter.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AckId</maml:name> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> <command:parameterValue required="true">PubSubMessageWithAckIdAndSubscription[]</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The list of AckIds of the pulled messages from the provided subscription. This parameter is used with -Name parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.PowerShell.PubSub.PubSubMessageWithAckIdAndSubscription[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The list of PubSub messages that the cmdlet will send acknowledgement for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GcpsAckDeadline -Subscription "my-subscription" -AckId "ackId" -AckDeadline 10</dev:code> <dev:remarks> <maml:para>This command sets the acknowledgement deadline for message with Ack Id "ackId" from subscription "my-subscription" in the default project to 10s.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GcpsAckDeadline -Subscription "my-subscription" ` -AckId "ackId1", "ackId2" -Project "my-project" -AckDeadline 10</dev:code> <dev:remarks> <maml:para>This command sets the acknowledgement deadline for messages with Ack Ids "ackId1" and "ackId2" from subscription "my-subscription" in the project "my-project" to 10s.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> $messages = Get-GcpsMessage -Subscription "my-subscription" PS C:\> Set-GcpsAckDeadline -InputObject $messages -AckDeadline 10</dev:code> <dev:remarks> <maml:para>This command sets the acknowledgement deadline for messages pulled from subscription "my-subscription" to 10s.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Pull Messages Acknowledgement Deadline] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#ack_deadline)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcpsMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcpsMessage</command:name> <command:verb>Get</command:verb> <command:noun>GcpsMessage</command:noun> <maml:description> <maml:para>Gets a Google Cloud PubSub message from a pull config subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a Google Cloud PubSub message from a pull config subscription. Will raise errors if the subscription does not exist. The default project will be used to search for the subscription if -Project is not used. If -AutoAck switch is supplied, each message received will be acknowledged automatically. If there is more than one message for the subscription, the cmdlet may not get all of them in one call. By default, the cmdlet will block until at least one message is returned. If -ReturnImmediately is used, the cmdlet will not block.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcpsMessage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for the subscription. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Subscription"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription to pull the messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxMessages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxMessages</maml:name> <maml:description> <maml:para>The maximum number of messages that can be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoAck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoAck</maml:name> <maml:description> <maml:para>If set, automatically send acknowledgement for each message received.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReturnImmediately --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReturnImmediately</maml:name> <maml:description> <maml:para>If set, the cmdlet will not block when there are no messages.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for the subscription. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Subscription"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription to pull the messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Subscription"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription to pull the messages from.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaxMessages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxMessages</maml:name> <maml:description> <maml:para>The maximum number of messages that can be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AutoAck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoAck</maml:name> <maml:description> <maml:para>If set, automatically send acknowledgement for each message received.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReturnImmediately --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReturnImmediately</maml:name> <maml:description> <maml:para>If set, the cmdlet will not block when there are no messages.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the subscription to pull the messages from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcpsMessage -Subscription "my-subscription"</dev:code> <dev:remarks> <maml:para>This command pulls down one or more messages from the subscription "my-subscription" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcpsMessage -Subscription "my-subscription" -ReturnImmediately</dev:code> <dev:remarks> <maml:para>This command pulls down one or more messages from the subscription "my-subscription" in the default project and it will not block even if no messages are returned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcpsMessage -Subscription "my-subscription" -Project "my-project" -MaxMessage 10</dev:code> <dev:remarks> <maml:para>This command pulls down a maximum of 10 messages from the subscription "my-subscription" in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GcpsMessage -Subscription "my-subscription" -AutoAck</dev:code> <dev:remarks> <maml:para>This command pulls down one or more messages from the subscription "my-subscription" in the default project and sends an acknowledgement for each message.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [PubSub Message] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Receiving Pull Messages] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#receiving-pull-messages)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcpsMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcpsMessage</command:name> <command:verb>New</command:verb> <command:noun>GcpsMessage</command:noun> <maml:description> <maml:para>Creates a Google Cloud PubSub message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a Google Cloud PubSub message. The message created is intended to be used with Publish-GcpsMessage cmdlet to publish it to a topic. The message payload must not be empty; it must contain either a non-empty data field or at least one attribute. The cmdlet will base64-encode the message data.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcpsMessage</maml:name> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>The message payload. This will be base64-encoded by the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Optional attributes for this message.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>The message payload. This will be base64-encoded by the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Optional attributes for this message.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcpsMessage -Data "my-data"</dev:code> <dev:remarks> <maml:para>This command creates a new message with data "my-data".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcpsMessage -Data "my-data" -Attributes @{"key"="value"}</dev:code> <dev:remarks> <maml:para>This command creates a new message with data "my-data" and an attribute pair "key", "value".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [PubSub Message] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Publish-GcpsMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Publish-GcpsMessage</command:name> <command:verb>Publish</command:verb> <command:noun>GcpsMessage</command:noun> <maml:description> <maml:para>Publishes one or more PubSub messages to a topic.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publishes one or more PubSub messages to a topic. Will raise errors if the topic does not exist. The cmdlet will search for the topic in the default project if -Project is not used. To publish more than one message, use -Message parameter with an array of messages constructed from New-GcpsMessage. Otherwise, use -Data and -Attribute parameters to publish a single message.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DataAndAttributes --> <command:syntaxItem> <maml:name>Publish-GcpsMessage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for topic. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The topic to which the messages will be published.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>The data message that will be published.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes of the message that will be published.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Message --> <command:syntaxItem> <maml:name>Publish-GcpsMessage</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for topic. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The topic to which the messages will be published.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Messages to be published. Use this parameter to publish one or more messages.</maml:para> </maml:description> <command:parameterValue required="true">PubsubMessage[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Pubsub.v1.Data.PubsubMessage[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for topic. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The topic to which the messages will be published.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Data --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Data</maml:name> <maml:description> <maml:para>The data message that will be published.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes of the message that will be published.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Messages to be published. Use this parameter to publish one or more messages.</maml:para> </maml:description> <command:parameterValue required="true">PubsubMessage[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Pubsub.v1.Data.PubsubMessage[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Publish-GcpsTopic -Topic "my-topic" -Data "This is a test." -Attributes @{"key"="value"}</dev:code> <dev:remarks> <maml:para>This command publishes a message with the specified data and attribute to topic "my-topic" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $message1 = New-GcpsMessage -Data "my-data" PS C:\> $message2 = New-GcpsMessage -Data "my-data2" -Attributes @{"key"="test"} PS C:\> Publish-GcpsTopic -Topic "my-topic" -Message $message1, $message2 -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command publishes 2 messages to topic "my-topic" in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Publishing Messages to a Topic] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/publisher#publish-messages-to-a-topic)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcpsSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcpsSubscription</command:name> <command:verb>Get</command:verb> <command:noun>GcpsSubscription</command:noun> <maml:description> <maml:para>Retrieves one or more Google Cloud PubSub subscriptions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves one or more Google Cloud PubSub subscriptions. The cmdlet will search for subscriptions in the default project if -Project is not used. If -Topic is used, the cmdlet will only return subscriptions belonging to the specified topic. If -Subscription is used, the cmdlet will only return subscriptions whose names match the subscriptions' names provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcpsSubscription</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for subscriptions. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The names of the subscriptions to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The topic to check for subscriptions.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for subscriptions. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The names of the subscriptions to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the subscriptions to be retrieved.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The topic to check for subscriptions.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription</dev:code> <dev:remarks> <maml:para>This command retrieves all subscriptions in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription -Topic "my-topic" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command retrieves all subscriptions that belong to topic "my-topic" in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription -Subscription "subscription1", "subscription2"</dev:code> <dev:remarks> <maml:para>This command retrieves subscriptions "subscription1" and "subscription2" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription -Subscription "subscription1", "subscription2" -Topic "my-topic"</dev:code> <dev:remarks> <maml:para>This command retrieves subscriptions "subscription1" and "subscription2" in the topic "my-topic".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Subscription] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#overview-of-subscriptions)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcpsSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcpsSubscription</command:name> <command:verb>New</command:verb> <command:noun>GcpsSubscription</command:noun> <maml:description> <maml:para>Creates a new Google Cloud PubSub subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new Google Cloud PubSub subscription. Will raise errors if the subscription already exist. The cmdlet will create the subscription in the default project if -Project is not used. Subscription created will default to pull mode if -PushEndPoint is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcpsSubscription</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the subscription in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription to be created. Subscription must not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The name of the topic that the subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckDeadline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AckDeadline</maml:name> <maml:description> <maml:para>The number of seconds after delivery, during which the subscriber must acknowledge the receipt of a pull or push message. By default, the deadline is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PushEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PushEndpoint</maml:name> <maml:description> <maml:para>A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the subscription in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription to be created. Subscription must not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription to be created. Subscription must not exist.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The name of the topic that the subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AckDeadline --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AckDeadline</maml:name> <maml:description> <maml:para>The number of seconds after delivery, during which the subscriber must acknowledge the receipt of a pull or push message. By default, the deadline is 10 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PushEndpoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PushEndpoint</maml:name> <maml:description> <maml:para>A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcpsSubscription -Topic "my-topic" -Subscription "my-subscription"</dev:code> <dev:remarks> <maml:para>This command creates a new subscription called "my-subscription" that subscribes to "my-topic" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcpsTopic -Topic "my-topic" -Subscription "my-subscription" -Project "my-project" -AckDeadline 30</dev:code> <dev:remarks> <maml:para>This command creates a new subscription called "my-subscription" that subscribes to "my-topic" in the "my-project" project with an acknowledgement deadline of 30s.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GcpsTopic -Topic "my-topic" ` -Subscription "my-subscription" ` -PushEndpoint https://www.example.com/push `</dev:code> <dev:remarks> <maml:para>This command creates a new subscription called "my-subscription" that subscribes to "my-topic" in the "my-project" project with a push endpoint at https://www.example.com/push and the attribute "x-goog-version" of the endpoint set to "v1beta".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Subscription] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#overview-of-subscriptions)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Push Config] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions#PushConfig)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Ack Deadline] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#ack_deadline)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcpsSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcpsSubscription</command:name> <command:verb>Remove</command:verb> <command:noun>GcpsSubscription</command:noun> </command:details> <maml:description> <maml:para>Removes one or more Gooogle Cloud PubSub subscriptions. Will raise errors if the subscriptions do not exist. The cmdlet will delete the subscriptions in the default project if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcpsSubscription</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for subscriptions. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The names of the subscriptions to be removed. Subscriptions must exist.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for subscriptions. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The names of the subscriptions to be removed. Subscriptions must exist.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the subscriptions to be removed. Subscriptions must exist.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the subscriptions to be removed. Subscriptions must exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcpsSubscription -Subscription "my-subscription"</dev:code> <dev:remarks> <maml:para>This command removes subscription "my-subscription" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcpsTopic -Subscription "subscription1", "subscription2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes 2 topics ("subscription1" and "subscription1") in the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription -Topic "my-topic" | Remove-GcpsSubscription</dev:code> <dev:remarks> <maml:para>This command removes all subscriptions to topic "my-topic" by pipelining from Get-GcpsSubscription.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Deleting a Subscription] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#delete)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GcpsSubscriptionConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GcpsSubscriptionConfig</command:name> <command:verb>Set</command:verb> <command:noun>GcpsSubscriptionConfig</command:noun> <maml:description> <maml:para>Changes the config of a subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Changes the config of a subscription from push to pull and vice versa. The cmdlet can also be used to change the endpoint of a push subscription. Will raise error if the subscription cannot be found. No errors will be raised if a subscription with a pull config is set to pull config again or if a subscription with push config is set to the same endpoint.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PushConfig --> <command:syntaxItem> <maml:name>Set-GcpsSubscriptionConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the config's subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the config belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PushEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PushEndpoint</maml:name> <maml:description> <maml:para>A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PullConfig --> <command:syntaxItem> <maml:name>Set-GcpsSubscriptionConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the config's subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the config belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PullConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PullConfig</maml:name> <maml:description> <maml:para>If set, the cmdlet will change config of the subscription to a pull config.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the config's subscription belongs to. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscription --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The name of the subscription that the config belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription that the config belongs to.</maml:para> <maml:para>This is an alias of the Subscription parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PushEndpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PushEndpoint</maml:name> <maml:description> <maml:para>A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PullConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PullConfig</maml:name> <maml:description> <maml:para>If set, the cmdlet will change config of the subscription to a pull config.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the subscription that the config belongs to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GcpsSubscriptionConfig -Subscription "my-subscription" -PullConfig</dev:code> <dev:remarks> <maml:para>This command sets the config of subscription "my-subscription" in the default project to pull config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcpsSubscription -Topic "my-topic" | Set-GcpsSubscriptionConfig -PullConfig</dev:code> <dev:remarks> <maml:para>This command sets the config of all subscriptions of topic "my-topic" to pull config by pipelining.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GcpsSubscriptionConfig -Subscription "my-subscription" -PushEndpoint https://www.example.com -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command sets the config of subscription "my-subscription" in the project "my-project" to a push config with endpoint https://www.example.com.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Subscription] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/subscriber#overview-of-subscriptions)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Push Config] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions#PushConfig)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcpsTopic --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcpsTopic</command:name> <command:verb>Get</command:verb> <command:noun>GcpsTopic</command:noun> <maml:description> <maml:para>Retrieves Google Cloud PubSub topics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcpsTopic</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for topics. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for topics. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the topics to be retrieved.</maml:para> <maml:para>This is an alias of the Topic parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcpsTopic</dev:code> <dev:remarks> <maml:para>This command retrieves all topics in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcpsTopic -Topic "topic1", "topic2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command retrieves 2 topics ("topic1" and "topic2") in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Listing a Topic] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/publisher#list-topics-in-your-project)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcpsTopic --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcpsTopic</command:name> <command:verb>New</command:verb> <command:noun>GcpsTopic</command:noun> <maml:description> <maml:para>Creates new Google Cloud PubSub topics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates one or more Gooogle Cloud PubSub topics. Will raise errors if the topics already exist. The cmdlet will create the topics in the default project if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcpsTopic</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the topics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be created. Topics must not exist.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to create the topics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be created. Topics must not exist.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the topics to be created. Topics must not exist.</maml:para> <maml:para>This is an alias of the Topic parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcpsTopic -Topic "my-topic"</dev:code> <dev:remarks> <maml:para>This command creates a new topic called "my-topic" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcpsTopic -Topic "topic1", "topic2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command creates 2 topics ("topic1" and "topic2") in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Creating a Topic] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/publisher#create-a-topic)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcpsTopic --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcpsTopic</command:name> <command:verb>Remove</command:verb> <command:noun>GcpsTopic</command:noun> <maml:description> <maml:para>Removes Google Cloud PubSub topics.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more Gooogle Cloud PubSub topics. Will raise errors if the topics do not exist. The cmdlet will delete the topics in the default project if -Project is not used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcpsTopic</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to remove the topics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to remove the topics in. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Topic --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Topic</maml:name> <maml:description> <maml:para>The names of the topics to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the topics to be removed.</maml:para> <maml:para>This is an alias of the Topic parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The names of the topics to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcpsTopic -Topic "my-topic"</dev:code> <dev:remarks> <maml:para>This command removes topic "my-topic" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcpsTopic -Topic "topic1", "topic2" -Project "my-project"</dev:code> <dev:remarks> <maml:para>This command removes 2 topics ("topic1" and "topic2") in the project "my-project".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Deleting a Topic] </maml:linkText> <maml:uri>(https://cloud.google.com/pubsub/docs/publisher#delete)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcsBucket --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcsBucket</command:name> <command:verb>Get</command:verb> <command:noun>GcsBucket</command:noun> <maml:description> <maml:para>Gets Google Cloud Storage buckets</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If a name is specified, gets the Google Cloud Storage bucket with the given name. The gcloud user must have access to view the bucket.</maml:para> <maml:para>If a name is not specified, gets all Google Cloud Storage buckets owned by a project. The project can be specifed. If it is not, the project in the active Cloud SDK configuration will be used. The gcloud user must have access to view the project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SingleBucket --> <command:syntaxItem> <maml:name>Get-GcsBucket</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BucketsByProject --> <command:syntaxItem> <maml:name>Get-GcsBucket</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for Storage buckets. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to return.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to check for Storage buckets. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcsBucket "widget-co-logs"</dev:code> <dev:remarks> <maml:para>Get the bucket named "widget-co-logs".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcsBucket -Project "widget-co"</dev:code> <dev:remarks> <maml:para>Get all buckets for project "widget-co".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-GcsBucket</dev:code> <dev:remarks> <maml:para>Get all buckets for current project in the active gcloud configuration.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-GcsBucket --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcsBucket</command:name> <command:verb>New</command:verb> <command:noun>GcsBucket</command:noun> <maml:description> <maml:para>Creates a new Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new Google Cloud Storage bucket. Bucket names must be globally unique. No two projects may have buckets with the same name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcsBucket</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the bucket.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project associated with the command. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageClass --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageClass</maml:name> <maml:description> <maml:para>Storage class for the bucket. COLDLINE, DURABLE_REDUCED_AVAILABILITY, MULTI_REGIONAL, NEARLINE, REGIONAL or STANDARD. See https://cloud.google.com/storage/docs/storage-classes for more information.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Location --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location for the bucket. e.g. ASIA, EU, US.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultBucketAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultBucketAcl</maml:name> <maml:description> <maml:para>Default ACL for the bucket. "Private__" gives the bucket owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the bucket owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the bucket owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "PublicReadWrite" gives the bucket owner "OWNER" permission and gives all user "READER" and "WRITER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsBucketAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, Private__, ProjectPrivate, PublicRead, PublicReadWrite</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.BucketsResource+InsertRequest+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicReadWrite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DefaultObjectAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultObjectAcl</maml:name> <maml:description> <maml:para>Default ACL for objects added to the bucket. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedDefaultObjectAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.BucketsResource+InsertRequest+PredefinedDefaultObjectAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the bucket.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project associated with the command. If not set via PowerShell parameter processing, will default to the Cloud SDK's DefaultProject property.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageClass --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageClass</maml:name> <maml:description> <maml:para>Storage class for the bucket. COLDLINE, DURABLE_REDUCED_AVAILABILITY, MULTI_REGIONAL, NEARLINE, REGIONAL or STANDARD. See https://cloud.google.com/storage/docs/storage-classes for more information.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Location --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location for the bucket. e.g. ASIA, EU, US.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultBucketAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultBucketAcl</maml:name> <maml:description> <maml:para>Default ACL for the bucket. "Private__" gives the bucket owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the bucket owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the bucket owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "PublicReadWrite" gives the bucket owner "OWNER" permission and gives all user "READER" and "WRITER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsBucketAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, Private__, ProjectPrivate, PublicRead, PublicReadWrite</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.BucketsResource+InsertRequest+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicReadWrite</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: DefaultObjectAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultObjectAcl</maml:name> <maml:description> <maml:para>Default ACL for objects added to the bucket. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedDefaultObjectAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.BucketsResource+InsertRequest+PredefinedDefaultObjectAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-Gcsbucket "widget-co-logs"</dev:code> <dev:remarks> <maml:para>Creates a new bucket named "widget-co-logs".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-GcsBucket --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsBucket</command:name> <command:verb>Remove</command:verb> <command:noun>GcsBucket</command:noun> <maml:description> <maml:para>Deletes a Google Cloud Storage Bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a Google Cloud Storage Bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcsBucket</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When deleting a bucket with objects still inside, use Force to proceed with the deletion without a prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When deleting a bucket with objects still inside, use Force to proceed with the deletion without a prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the bucket to remove. This parameter will also accept a Bucket object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucket "unique-bucket-name"</dev:code> <dev:remarks> <maml:para>Deletes the bucket "unique-bucket-name"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcsBucket "bucket-with-files" | Remove-GcsBucket -Force</dev:code> <dev:remarks> <maml:para>Forces the deletion of "bucket-with-files, despite the bucket containing objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucket prod-database -WhatIf What if: Performing the operation "Delete Bucket" on target "prod-database".</dev:code> <dev:remarks> <maml:para>Prints what would happen if trying to delete bucket "prod-database".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-GcsBucket --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-GcsBucket</command:name> <command:verb>Test</command:verb> <command:noun>GcsBucket</command:noun> <maml:description> <maml:para>Tests if a bucket with the given name already exists.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests if a bucket with the given name already exists. Returns true if such a bucket already exists.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-GcsBucket</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to test for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to test for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Test-GcsBucket "bucket-name" True</dev:code> <dev:remarks> <maml:para>Tests that a bucket named "bucket-name" does exist. A new bucket with this name may not be created.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Test-GcsBucket "foo"</dev:code> <dev:remarks> <maml:para>Check if bucket "foo" exists.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GcsBucketAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcsBucketAcl</command:name> <command:verb>Add</command:verb> <command:noun>GcsBucketAcl</command:noun> <maml:description> <maml:para>Add an access control to a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add an access control to a Google Cloud Storage bucket for an entity. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Add-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: BucketAccessControl --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.BucketAccessControl</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcsBucketAcl -Role Reader -Bucket "my-bucket" -User user@example.com</dev:code> <dev:remarks> <maml:para>Adds reader access control to bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GcsBucketAcl -Role Writer -Bucket "my-bucket" -Domain example.com</dev:code> <dev:remarks> <maml:para>Adds writer access control to bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GcsBucketAcl -Role Owner -Bucket "my-bucket" -AllUsers</dev:code> <dev:remarks> <maml:para>Adds owner access control to bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Add-GcsBucketAcl -Role Owner -Bucket "my-bucket" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Adds owner access control to bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Bucket Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcsBucketAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcsBucketAcl</command:name> <command:verb>Get</command:verb> <command:noun>GcsBucketAcl</command:noun> <maml:description> <maml:para>Gets all the access controls of a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the access controls of a Google Cloud Storage bucket. User must have access to the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: BucketAccessControls --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.BucketAccessControls</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GetGcsBucketAcl -Bucket "my-bucket"</dev:code> <dev:remarks> <maml:para>Gets all access controls of bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Bucket Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcsBucketAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsBucketAcl</command:name> <command:verb>Remove</command:verb> <command:noun>GcsBucketAcl</command:noun> <maml:description> <maml:para>Removes an access control from a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an access control from a Google Cloud Storage bucket for an entity. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the bucket. Assumes the entity already have an access control for the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Remove-GcsBucketAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketAcl -Bucket "my-bucket" -User user@example.com</dev:code> <dev:remarks> <maml:para>Removes access control to bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketAcl -Bucket "my-bucket" -Domain example.com</dev:code> <dev:remarks> <maml:para>Removes access control to bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketAcl -Bucket "my-bucket" -AllUsers</dev:code> <dev:remarks> <maml:para>Removes access control to bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketAcl -Bucket "my-bucket" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Removes access control to bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Bucket Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcsBucketLogging --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsBucketLogging</command:name> <command:verb>Remove</command:verb> <command:noun>GcsBucketLogging</command:noun> <maml:description> <maml:para>Removes the logging data associated with a Cloud Storage Bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the logging data associated with a Cloud Storage Bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcsBucketLogging</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove logging for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove logging for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketLogging "widgetco"</dev:code> <dev:remarks> <maml:para>Stop generating logs data for access to bucket "widgetco".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Access Logs]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-logs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Write-GcsBucketLogging --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Write-GcsBucketLogging</command:name> <command:verb>Write</command:verb> <command:noun>GcsBucketLogging</command:noun> <maml:description> <maml:para>Updates the logging data associated with a Cloud Storage Bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the logging data associated with a Cloud Storage Bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Write-GcsBucketLogging</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to configure. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogBucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LogBucket</maml:name> <maml:description> <maml:para>The destination bucket where the current bucket's logs should be placed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogObjectPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LogObjectPrefix</maml:name> <maml:description> <maml:para>Prefix for the log object's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to configure. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogBucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LogBucket</maml:name> <maml:description> <maml:para>The destination bucket where the current bucket's logs should be placed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogObjectPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LogObjectPrefix</maml:name> <maml:description> <maml:para>Prefix for the log object's name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Write-GcsBucketLogging "widgetco" -LogBucket "widgetco-logs" ` -LogObjectPrefix "log-output/bucket"</dev:code> <dev:remarks> <maml:para>Start generating logs data for access to bucket "widgetco".</maml:para> <maml:para>Logs should be accessible afterwards via, at "gs://widgetco-logs/log-output/bucket_usage_<timestamp>_<id>_v0".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Access Logs]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-logs)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcsBucketWebsite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsBucketWebsite</command:name> <command:verb>Remove</command:verb> <command:noun>GcsBucketWebsite</command:noun> <maml:description> <maml:para>Removes the website associated with a Cloud Storage Bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the website associated with a Cloud Storage Bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-GcsBucketWebsite</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove logging for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to remove logging for. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsBucketWebsite $bucket</dev:code> <dev:remarks> <maml:para>Remove the website data for $bucket.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Static Website Hosting]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/hosting-static-website)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Static Website Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/static-website)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Write-GcsBucketWebsite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Write-GcsBucketWebsite</command:name> <command:verb>Write</command:verb> <command:noun>GcsBucketWebsite</command:noun> <maml:description> <maml:para>Updates the website associated with a Cloud Storage Bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the website associated with a Cloud Storage Bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Write-GcsBucketWebsite</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to configure. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MainPageSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MainPageSuffix</maml:name> <maml:description> <maml:para>Storage object for the "main page" of the website, e.g. what is served from "http://example.com/". Defaults to "index.html".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>index.html</dev:defaultValue> </command:parameter> <!-- Parameter: NotFoundPage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NotFoundPage</maml:name> <maml:description> <maml:para>Storage object to render when no appropriate file is found, e.g. what is served from "http://example.com/sadjkffasugmd". Defaults to "404.html".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>404.html</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket to configure. This parameter will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MainPageSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MainPageSuffix</maml:name> <maml:description> <maml:para>Storage object for the "main page" of the website, e.g. what is served from "http://example.com/". Defaults to "index.html".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>index.html</dev:defaultValue> </command:parameter> <!-- Parameter: NotFoundPage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NotFoundPage</maml:name> <maml:description> <maml:para>Storage object to render when no appropriate file is found, e.g. what is served from "http://example.com/sadjkffasugmd". Defaults to "404.html".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>404.html</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Write-GcsBucketWebsite $bucket -MainPageSuffix "main.html" -NotFoundPage "error.html"</dev:code> <dev:remarks> <maml:para>Host http://example.com from the contents of $bucket.</maml:para> <maml:para>Next, set the domains DNS records to point to Cloud Storage. See the "Static WebsiteHosting" help topic for more information.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Static Website Hosting]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/hosting-static-website)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>[Static Website Troubleshooting]</maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/static-website)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GcsDefaultObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcsDefaultObjectAcl</command:name> <command:verb>Add</command:verb> <command:noun>GcsDefaultObjectAcl</command:noun> <maml:description> <maml:para>Add a default access control to a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a default access control to a Google Cloud Storage bucket for an entity. The default access control will be aplied to a new object when no access control is provided. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Add-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectAccessControl --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.ObjectAccessControl</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcsDefaultObjectAcl -Role Reader -Bucket "my-bucket" -User user@example.com</dev:code> <dev:remarks> <maml:para>Adds reader default access control to bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GcsDefaultObjectAcl -Role Writer -Bucket "my-bucket" -Domain example.com</dev:code> <dev:remarks> <maml:para>Adds writer default access control to bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GcsDefaultObjectAcl -Role Owner -Bucket "my-bucket" -AllUsers</dev:code> <dev:remarks> <maml:para>Adds owner default access control to bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Add-GcsDefaultObjectAcl -Role Owner -Bucket "my-bucket" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Adds owner default access control to bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Default Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcsDefaultObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcsDefaultObjectAcl</command:name> <command:verb>Get</command:verb> <command:noun>GcsDefaultObjectAcl</command:noun> <maml:description> <maml:para>Gets all the default access controls of a Google Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the default access controls of a Google Cloud Storage object. User must have access to the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectAccessControls --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.ObjectAccessControls</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcsDefaultObjectAcl -Bucket "my-bucket" -ObjectName "my-object"</dev:code> <dev:remarks> <maml:para>Gets all default access controls of the object "my-object" in bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Default Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcsDefaultObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsDefaultObjectAcl</command:name> <command:verb>Remove</command:verb> <command:noun>GcsDefaultObjectAcl</command:noun> <maml:description> <maml:para>Removes a default access control from a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a default access control from a Google Cloud Storage bucket for an entity. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the bucket. Assumes the entity already have an access control for the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Remove-GcsDefaultObjectAcl</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Bucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> <maml:para>This is an alias of the Name parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsDefaultObjectAcl -Bucket "my-bucket" -User user@example.com</dev:code> <dev:remarks> <maml:para>Removes default access control to bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcsDefaultObjectAcl -Bucket "my-bucket" -Domain example.com</dev:code> <dev:remarks> <maml:para>Removes default access control to bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcsDefaultObjectAcl -Bucket "my-bucket" -AllUsers</dev:code> <dev:remarks> <maml:para>Removes default access control to bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Remove-GcsDefaultObjectAcl -Bucket "my-bucket" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Removes default access control to bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Default Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-GcsObject</command:name> <command:verb>Copy</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Copies a Google Cloud Storage object to another location.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies a Google Cloud Storage object to another location The target location may be in the same bucket with a different name or a different bucket with any name.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Copy-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Google Cloud Storage object to read from. Can be obtained with Get-GcsObject or Find-GcsObject.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationBucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationBucket</maml:name> <maml:description> <maml:para>Name of the bucket in which the copy will reside. Defaults to the source bucket.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationObjectName</maml:name> <maml:description> <maml:para>The name of the copy. Defaults to the name of the source object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, will overwrite existing objects without prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Copy-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="SourceBucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object to read from. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SourceObjectName"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to read from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationBucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationBucket</maml:name> <maml:description> <maml:para>Name of the bucket in which the copy will reside. Defaults to the source bucket.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationObjectName</maml:name> <maml:description> <maml:para>The name of the copy. Defaults to the name of the source object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, will overwrite existing objects without prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A Google Cloud Storage object to read from. Can be obtained with Get-GcsObject or Find-GcsObject.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="SourceBucket"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object to read from. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="SourceBucket"> <maml:name>SourceBucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object to read from. Will also accept a Bucket object.</maml:para> <maml:para>This is an alias of the Bucket parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SourceObjectName"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to read from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="SourceObjectName"> <maml:name>SourceObjectName</maml:name> <maml:description> <maml:para>Name of the object to read from.</maml:para> <maml:para>This is an alias of the ObjectName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationBucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationBucket</maml:name> <maml:description> <maml:para>Name of the bucket in which the copy will reside. Defaults to the source bucket.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DestinationObjectName</maml:name> <maml:description> <maml:para>The name of the copy. Defaults to the name of the source object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If set, will overwrite existing objects without prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A Google Cloud Storage object to read from. Can be obtained with Get-GcsObject or Find-GcsObject.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Object --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Copy-GcsObject -Bucket "widget-co-logs" -ObjectName "status.txt" -DestinationBucket "another-bucket"</dev:code> <dev:remarks> <maml:para>Copy object "status.txt" in bucket "widget-co-logs" to bucket "another-bucket".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Copy-GcsObject -ObjectName "status.txt" -DestinationBucket "another-bucket" -DestinationObjectName "new-name.txt"</dev:code> <dev:remarks> <maml:para>Copy object "status.txt" in bucket "my-bucket" to bucket "another-bucket" as "new-name.txt".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcsObject</command:name> <command:verb>Get</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Get-GcsObject returns Google Cloud Storage Objects and their metadata. (Use Read-GcsObject to get its contents.)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Given a Google Cloud Storage Bucket, returns Google Cloud Storage Objects and their metadata.</maml:para> <maml:para>If no parameter besides -Bucket is provided, all objects in the bucket are returned. If a given prefix string is provided, returns all Cloud Storage objects identified by the prefix string.</maml:para> <maml:para>An optional delimiter may be provided. If used, will return results in a directory-like mode, delimited by the given string. This means that the names of all objects returned will not, aside from the prefix, contain the delimiter. For example, with objects "1", "2", "subdir/3", "subdir/subdir/4", if the delimiter is "/", only "1" and "2" will be returned. If the delimiter is "/" and the prefix is "subdir/", only "subdir/3" will be returned.</maml:para> <maml:para>To gets a specific Cloud Storage Object by name, use the -ObjectName parameter. This parameter cannot be used together with -Prefix and -Delimiter parameters.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the name of the folder to -ObjectName if -ObjectName is used. If -ObjectName is not used, the cmdlet will use the name of the folder as a prefix by default if -Prefix is not used or prefix the folder name to -Prefix if -Prefix is used.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket to check. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to inspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Prefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Object prefix to use. e.g. "/logs/". If not specified all objects in the bucket will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>Returns results in a directory-like mode, delimited by the given string. e.g. with objects "1, "2", "subdir/3" and delimited "/", "subdir/3" would not be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket to check. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to inspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Prefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Object prefix to use. e.g. "/logs/". If not specified all objects in the bucket will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delimiter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delimiter</maml:name> <maml:description> <maml:para>Returns results in a directory-like mode, delimited by the given string. e.g. with objects "1, "2", "subdir/3" and delimited "/", "subdir/3" would not be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the bucket to check. Will also accept a Bucket object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Object --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcsObject -Bucket "widget-co-logs" -ObjectName "log-000.txt"</dev:code> <dev:remarks> <maml:para>Get the object name "log-000.txt" and their metadata.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcsObject -Bucket "widget-co-logs"</dev:code> <dev:remarks> <maml:para>Get all objects in a storage bucket.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcsObject -Bucket "widget-co-logs" -Prefix "pictures/winter" -Delimiter "/"</dev:code> <dev:remarks> <maml:para>Get all objects in a specific folder Storage Bucket.</maml:para> <maml:para>Because the Delimiter parameter was set, will not return objects under "pictures/winter/2016/". The search will omit any objects matching the prefix containing the delimiter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GcsObject -Bucket "widget-co-logs" -Prefix "pictures/winter"</dev:code> <dev:remarks> <maml:para>Get all objects in a specific folder Storage Bucket. Will return objects in pictures/winter/2016/.</maml:para> <maml:para>Because the Delimiter parameter was not set, will return objects under "pictures/winter/2016/".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket\my-folder PS gs:\my-bucket\my-folder> Get-GcsObject -ObjectName "Blah.txt"</dev:code> <dev:remarks> <maml:para>Get the object Blah.txt in folder "my-folder" in bucket "my-bucket". This has the same effect as "Get-GcsObject -Bucket my-bucket -ObjectName "my-folder/Blah.txt"</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcsObject</command:name> <command:verb>New</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Uploads a local file or folder into a Google Cloud Storage bucket.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uploads a local file or folder into a Google Cloud Storage bucket. You can set the value of the new object directly with -Value, read it from a file with -File, or define neither to create an empty object. You can also upload an entire folder by giving the folder path to -Folder. However, you will not be able to use -ObjectName or -ContentType parameter in this case. Use this instead of Write-GcsObject when creating a new Google Cloud Storage object. You will get a warning if the object already exists.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name. For example, if the location is gs:\my-bucket\folder-1\folder-2, the cmdlet will prefix "folder-1/folder-2/" to the object name. If -ObjectNamePrefix is used, the automatically determined folder prefix will be appended to the front of the value of -ObjectNamePrefix.</maml:para> <maml:para>Note: Most Google Cloud Storage utilities, including the PowerShell Provider and the Google Cloud Console treat '/' as a path separator. They do not, however, treat '\' the same. If you wish to create an empty object to treat as a folder, the name should end with '/'.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ContentsFromString --> <command:syntaxItem> <maml:name>New-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket to upload to. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the created Cloud Storage object.</maml:para> <maml:para>If uploading a file, will default to the name of the file if not set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File or Folder is specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> <maml:para>If this parameter is specified, will take precedence over any "Content-Type" value specifed by the -Metadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+InsertMediaUpload+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Provide metadata for the Cloud Storage object(s). Note that some values, such as "Content-Type", "Content-MD5", "ETag" have a special meaning to Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting existing Storage objects if needed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ContentsFromFile --> <command:syntaxItem> <maml:name>New-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket to upload to. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the created Cloud Storage object.</maml:para> <maml:para>If uploading a file, will default to the name of the file if not set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>File</maml:name> <maml:description> <maml:para>Local path to the file to upload.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> <maml:para>If this parameter is specified, will take precedence over any "Content-Type" value specifed by the -Metadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+InsertMediaUpload+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Provide metadata for the Cloud Storage object(s). Note that some values, such as "Content-Type", "Content-MD5", "ETag" have a special meaning to Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting existing Storage objects if needed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UploadFolder --> <command:syntaxItem> <maml:name>New-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket to upload to. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Local path to the folder to upload.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectNamePrefix</maml:name> <maml:description> <maml:para>When uploading the contents of a directory into Google Cloud Storage, this is the prefix applied to every object which is uploaded.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+InsertMediaUpload+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Provide metadata for the Cloud Storage object(s). Note that some values, such as "Content-Type", "Content-MD5", "ETag" have a special meaning to Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting existing Storage objects if needed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket to upload to. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the created Cloud Storage object.</maml:para> <maml:para>If uploading a file, will default to the name of the file if not set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File or Folder is specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>File</maml:name> <maml:description> <maml:para>Local path to the file to upload.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Folder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Local path to the folder to upload.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectNamePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectNamePrefix</maml:name> <maml:description> <maml:para>When uploading the contents of a directory into Google Cloud Storage, this is the prefix applied to every object which is uploaded.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> <maml:para>If this parameter is specified, will take precedence over any "Content-Type" value specifed by the -Metadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+InsertMediaUpload+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Provide metadata for the Cloud Storage object(s). Note that some values, such as "Content-Type", "Content-MD5", "ETag" have a special meaning to Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting existing Storage objects if needed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File or Folder is specified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Object --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcsObject -Bucket "widget-co-logs" -File "C:\logs\log-000.txt"</dev:code> <dev:remarks> <maml:para>Upload a local file to GCS. The -ObjectName parameter will default to the file name, "log-000.txt".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> "Hello, World!" | New-GcsObject -Bucket "widget-co-logs" -ObjectName "log-000.txt" ` -Metadata @{ "logsource" = $env:computername }</dev:code> <dev:remarks> <maml:para>Pipe a string to a file on GCS. Sets a custom metadata value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket\my-folder PS gs:\my-bucket\my-folder> "Hello, World!" | New-GcsObject -ObjectName "log-000.txt"</dev:code> <dev:remarks> <maml:para>Pipe a string to a file on GCS while using the GCS Provider. Here, the object created will be "my-folder/log-000.txt".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> New-GcsObject -Bucket "widget-co-logs" -Folder "$env:SystemDrive\inetpub\logs\LogFiles"</dev:code> <dev:remarks> <maml:para>Upload a folder and its contents to GCS. The names of the created objects will be relative to the folder.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Read-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Read-GcsObject</command:name> <command:verb>Read</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Read the contents of a Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads the contents of a Cloud Storage object. By default the contents will be written to the pipeline. If the -OutFile parameter is set, it will be written to disk instead.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Read-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to read.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Local file path to write the contents to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting any local files.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Read-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to read.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Local file path to write the contents to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting any local files.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to read.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to read.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Object"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to read.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Local file path to write the contents to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, overwriting any local files.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Google Cloud Storage object to read.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Read-GcsObject -Bucket "widget-co-logs" -ObjectName "log-000.txt" ` >> -OutFile "C:\logs\log-000.txt"</dev:code> <dev:remarks> <maml:para>Write the objects of a Storage Object to local disk at "C:\logs\log-000.txt".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Read-GcsObject -Bucket "widget-co-logs" -ObjectName "log-000.txt" | Write-Host</dev:code> <dev:remarks> <maml:para>Returns the storage object's contents as a string.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Read-GcsObject -ObjectName "log-000.txt" | Write-Host</dev:code> <dev:remarks> <maml:para>Returns contents of the storage object "log-000.txt" in bucket "my-bucket" as a string.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsObject</command:name> <command:verb>Remove</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Deletes a Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a Cloud Storage object.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromObjectName --> <command:syntaxItem> <maml:name>Remove-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromObjectObject --> <command:syntaxItem> <maml:name>Remove-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Name of the object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Name of the object to delete.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>Object</maml:name> <maml:description> <maml:para>Name of the object to delete.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the object to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsObject ppiper-prod text-files/14683615 -WhatIf</dev:code> <dev:remarks> <maml:para>Delete storage object named "text-files/14683615".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Remove-GcsObject -ObjectName "my-object"</dev:code> <dev:remarks> <maml:para>Removes the storage object "my-object" in bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GcsObject</command:name> <command:verb>Set</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Set-GcsObject updates metadata associated with a Cloud Storage Object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the metadata associated with a Cloud Storage Object, such as ACLs.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FromBucketAndObjName --> <command:syntaxItem> <maml:name>Set-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket to check. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+UpdateRequest+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: FromObjectObject --> <command:syntaxItem> <maml:name>Set-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Storage object instance to update.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+UpdateRequest+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket to check. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to update.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Storage object instance to update.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>Object</maml:name> <maml:description> <maml:para>Storage object instance to update.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PredefinedAcl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PredefinedAcl</maml:name> <maml:description> <maml:para>Set the object's ACL using PredefinedAcl. "Private__" gives the object owner "OWNER" permission. All other permissions are removed. "ProjectPrivate" gives permission to the project team based on their roles. Anyone who is part of the team has "READER" permission. Project owners and project editors have "OWNER" permission. All other permissions are removed. "AuthenticatedRead" gives the object owner "OWNER" permission and gives all authenticated Google account holders "READER" permission. All other permissions are removed. "PublicRead" gives the object owner "OWNER" permission and gives all users "READER" permission. All other permissions are removed. "BucketOwnerRead" gives the object owner "OWNER" permission and the bucket owner "READER" permission. All other permissions are removed. "BucketOwnerFullControl" gives the object and bucket owners "OWNER" permission. All other permissions are removed.</maml:para> <maml:para>To set fine-grained (e.g. individual users or domains) ACLs using PowerShell, use Add-GcsObjectAcl cmdlets.</maml:para> <maml:para>Possible values: AuthenticatedRead, BucketOwnerFullControl, BucketOwnerRead, Private__, ProjectPrivate, PublicRead</maml:para> </maml:description> <command:parameterValue required="true">PredefinedAclEnum</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.ObjectsResource+UpdateRequest+PredefinedAclEnum</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AuthenticatedRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerFullControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">BucketOwnerRead</command:parameterValue> <command:parameterValue required="false" variableLength="false">Private__</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProjectPrivate</command:parameterValue> <command:parameterValue required="false" variableLength="false">PublicRead</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Storage object instance to update.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Object --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GcsObject -Bucket "widget-co-logs" -ObjectName "my-object" -PredefinedAcl PublicRead</dev:code> <dev:remarks> <maml:para>Sets the ACL on object "my-object" in bucket "widget-co-logs" to PublicRead.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Set-GcsObject -ObjectName "my-object" -PredefinedAcl PublicRead</dev:code> <dev:remarks> <maml:para>Sets the ACL on object "my-object" in bucket "my-bucket" to PublicRead.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-GcsObject</command:name> <command:verb>Test</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Verify the existence of a Cloud Storage Object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Verify the existence of a Cloud Storage Object.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the containing bucket. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to check for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the containing bucket. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to check for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Test-GcsObject -Bucket "widget-co-logs" -ObjectName "status.txt"</dev:code> <dev:remarks> <maml:para>Test if an object named "status.txt" exists in the bucket "widget-co-logs".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Test-GcsObject -ObjectName "status.txt"</dev:code> <dev:remarks> <maml:para>Test if an object named "status.txt" exists in the bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Write-GcsObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Write-GcsObject</command:name> <command:verb>Write</command:verb> <command:noun>GcsObject</command:noun> <maml:description> <maml:para>Replaces the contents of a Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replaces the contents of a Cloud Storage object with data from the local disk or a value from the pipeline. Use this instead of New-GcsObject to set the contents of a Google Cloud Storage object that already exists. You will get a warning if the object does not exist.</maml:para> <maml:para>If this cmdlet is used when PowerShell is in a Google Cloud Storage Provider location (i.e, the shell's location starts with gs:\), then you may not need to supply -Bucket. For example, if the location is gs:\my-bucket, the cmdlet will automatically fill out -Bucket with "my-bucket". If -Bucket is still used, however, whatever value given will override "my-bucket". If the location is inside a folder on Google Cloud Storage, then the cmdlet will prefix the folder name to the object name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByObjectFromString --> <command:syntaxItem> <maml:name>Write-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to write to.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File is specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata for the Cloud Storage object. Values will be merged into the existing object. To delete a Metadata value, provide an empty string for its value.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, ignoring errors if no existing Storage object exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObjectFromFile --> <command:syntaxItem> <maml:name>Write-GcsObject</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to write to.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>File</maml:name> <maml:description> <maml:para>Local file path to read, writing its contents into Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata for the Cloud Storage object. Values will be merged into the existing object. To delete a Metadata value, provide an empty string for its value.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, ignoring errors if no existing Storage object exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNameFromString --> <command:syntaxItem> <maml:name>Write-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to write to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File is specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata for the Cloud Storage object. Values will be merged into the existing object. To delete a Metadata value, provide an empty string for its value.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, ignoring errors if no existing Storage object exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNameFromFile --> <command:syntaxItem> <maml:name>Write-GcsObject</maml:name> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to write to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>File</maml:name> <maml:description> <maml:para>Local file path to read, writing its contents into Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata for the Cloud Storage object. Values will be merged into the existing object. To delete a Metadata value, provide an empty string for its value.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, ignoring errors if no existing Storage object exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to write to.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0" aliases="Object"> <maml:name>Object</maml:name> <maml:description> <maml:para>The Google Cloud Storage object to write to.</maml:para> <maml:para>This is an alias of the InputObject parameter.</maml:para> </maml:description> <command:parameterValue required="true">Object</command:parameterValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Bucket --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>Name of the bucket containing the object. Will also accept a Bucket object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>Name of the object to write to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File is specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>File</maml:name> <maml:description> <maml:para>Local file path to read, writing its contents into Cloud Storage.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Content type of the Cloud Storage object. e.g. "image/png" or "text/plain".</maml:para> <maml:para>For file uploads, the type will be inferred based on the file extension, defaulting to "application/octet-stream" if no match is found. When passing object content via the -Value parameter, the type will default to "text/plain; charset=utf-8".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata for the Cloud Storage object. Values will be merged into the existing object. To delete a Metadata value, provide an empty string for its value.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force the operation to succeed, ignoring errors if no existing Storage object exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Google Cloud Storage object to write to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Text content to write to the Storage object. Ignored if File is specified.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Object --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Object</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcsObject -Bucket "widget-co-logs" -ObjectName "status.txt" | Write-GcsObject -Value "OK"</dev:code> <dev:remarks> <maml:para>Update the contents of the Storage Object piped from Get-GcsObject.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> cd gs:\my-bucket PS gs:\my-bucket> Write-GcsObject -ObjectName "log-000.txt" -Value "OK"</dev:code> <dev:remarks> <maml:para>Updates the contents of the storage object "log-000.txt" in bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GcsObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcsObjectAcl</command:name> <command:verb>Add</command:verb> <command:noun>GcsObjectAcl</command:noun> <maml:description> <maml:para>Add an access control to a Google Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add an access control to a Google Cloud Storage object for an entity. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Add-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Role --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role of the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectAccessControl --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.ObjectAccessControl</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcsObjectAcl -Role Reader -Bucket "my-bucket" -ObjectName "my-object" -User user@example.com</dev:code> <dev:remarks> <maml:para>Adds reader access control to the object "my-object" in bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GcsObjectAcl -Role Writer -Bucket "my-bucket" -ObjectName "my-object" -Domain example.com</dev:code> <dev:remarks> <maml:para>Adds writer access control to the object "my-object" in bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GcsObjectAcl -Role Owner -Bucket "my-bucket" -ObjectName "my-object" -AllUsers</dev:code> <dev:remarks> <maml:para>Adds owner access control to the object "my-object" in bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Add-GcsObjectAcl -Role Owner -Bucket "my-bucket" -ObjectName "my-object" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Adds owner access control to the object "my-object" in bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Object Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcsObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcsObjectAcl</command:name> <command:verb>Get</command:verb> <command:noun>GcsObjectAcl</command:noun> <maml:description> <maml:para>Gets all the access controls of a Google Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets all the access controls of a Google Cloud Storage object. User must have access to the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that we retrieves the access controls from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ObjectAccessControls --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.ObjectAccessControls</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcsObjectAcl -Bucket "my-bucket" -ObjectName "my-object"</dev:code> <dev:remarks> <maml:para>Gets all access controls of the object "my-object" in bucket "my-bucket".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Object Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcsObjectAcl --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcsObjectAcl</command:name> <command:verb>Remove</command:verb> <command:noun>GcsObjectAcl</command:noun> <maml:description> <maml:para>Removes an access control from a Google Cloud Storage object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an access control from a Google Cloud Storage object for an entity. Entity can be user ID, user email address, project team, group ID, group email address, all users or all authenticated users. The roles that can be assigned to an entity are Reader, Writer and Owner. User must have access to the bucket. Assumes the entity already have an access control for the bucket.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: User --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Domain --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Team --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllUsers --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AllAuthenticatedUsers --> <command:syntaxItem> <maml:name>Remove-GcsObjectAcl</maml:name> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Bucket --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Bucket</maml:name> <maml:description> <maml:para>The name of the bucket that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ObjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ObjectName</maml:name> <maml:description> <maml:para>The name of the object that the access control will be removed from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>User</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserId</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="UserId,UserEmail"> <maml:name>UserEmail</maml:name> <maml:description> <maml:para>The user holding the access control. This can either be an email or a user ID.</maml:para> <maml:para>This is an alias of the User parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="GroupId,GroupEmail"> <maml:name>GroupEmail</maml:name> <maml:description> <maml:para>The group holding the access control. This can either be an email or an ID.</maml:para> <maml:para>This is an alias of the Group parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The domain holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectNumber --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectNumber</maml:name> <maml:description> <maml:para>The project number of the project holding the access control. This is used in conjunction with -ProjectRole parameter to specify a project team.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectRole --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectRole</maml:name> <maml:description> <maml:para>The project role (in the project specified by -ProjectNumber) holding the access control.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AllAuthenticatedUsers --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllAuthenticatedUsers</maml:name> <maml:description> <maml:para>If set, the access control will be for all authenticated user.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Bucket --> <command:returnValue> <dev:type> <maml:name>Google.Apis.Storage.v1.Data.Bucket</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcsObjectAcl -Bucket "my-bucket" -ObjectName "my-object" -User user@example.com</dev:code> <dev:remarks> <maml:para>Removes access control to the object "my-object" in bucket "my-bucket" for user user@example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcsObjectAcl -Bucket "my-bucket" -ObjectName "my-object" -Domain example.com</dev:code> <dev:remarks> <maml:para>Removes access control to the object "my-object" in bucket "my-bucket" for the domain example.com.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Remove-GcsObjectAcl -Bucket "my-bucket" -ObjectName "my-object" -AllUsers</dev:code> <dev:remarks> <maml:para>Removes access control to the object "my-object" in bucket "my-bucket" for all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Remove-GcsObjectAcl -Bucket "my-bucket" -ObjectName "my-object" -ProjectRole Owners -ProjectNumber 3423432</dev:code> <dev:remarks> <maml:para>Removes access control to the object "my-object" in bucket "my-bucket" for all owners of project 3423432.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Access Control Lists (ACLs)] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/access-control/lists)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Object Access Controls] </maml:linkText> <maml:uri>(https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcSqlBackupRun --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlBackupRun</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlBackupRun</command:noun> <maml:description> <maml:para>Retrieves a resource containing information about a backup run, or lists all backup runs for an instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a resource containing information about a backup run, or lists all backup runs for an instance. This is decided by if the "Id" parameter is filled or not.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Single --> <command:syntaxItem> <maml:name>Get-GcSqlBackupRun</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Backup Run we want to get</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Backup Run we want to get</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: BackupRun --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.BackupRun</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlBackupRun "myInstance"</dev:code> <dev:remarks> <maml:para>Gets a list of backup runs for the instance "myInstance".</maml:para> <maml:para>If successful, the command returns a list of backupruns the instance has.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlBackupRun "myInstance" "1234"</dev:code> <dev:remarks> <maml:para>Gets the resource for the backup run with ID "1234" from instance "myInstance".</maml:para> <maml:para>If successful, the command returns the relevant backup run.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Overview of Backups]</maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/backup-recovery/backups)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcSqlBackupRun --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcSqlBackupRun</command:name> <command:verb>Remove</command:verb> <command:noun>GcSqlBackupRun</command:noun> <maml:description> <maml:para>Deletes a specified backup from a Cloud SQL instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a specified backup from a Cloud SQL instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GcSqlBackupRun</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Backup Run we want to delete</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GcSqlBackupRun</maml:name> <!-- Parameter: Backup --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Backup</maml:name> <maml:description> <maml:para>The BackupRun that describes the backup we want to delete.</maml:para> </maml:description> <command:parameterValue required="true">BackupRun</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.BackupRun</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Backup Run we want to delete</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Backup --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Backup</maml:name> <maml:description> <maml:para>The BackupRun that describes the backup we want to delete.</maml:para> </maml:description> <command:parameterValue required="true">BackupRun</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.BackupRun</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.BackupRun</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The BackupRun that describes the backup we want to delete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcSqlBackupRun "myInstance" "1234"</dev:code> <dev:remarks> <maml:para>Removes the backup with ID "1234" from the instance "myInstance".</maml:para> <maml:para>If successful, the command doesn't return anything.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcSqlBackupRun $myBackup</dev:code> <dev:remarks> <maml:para>Removes the backup identified by the resource $myBackup.</maml:para> <maml:para>If successful, the command doesn't return anything.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managing Backups] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/backup)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Overview of Backups] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/backup-recovery/backups)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcSqlFlags --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlFlags</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlFlags</command:noun> <maml:description> <maml:para>Lists all available database flags for Google Cloud SQL instances.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all available database flags for instances.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: Flag --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Flag</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlFlags</dev:code> <dev:remarks> <maml:para>Gets a list of database flags available for instances.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcSqlInstance</command:name> <command:verb>Add</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Creates a new Cloud SQL instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates the Cloud SQL instance resource in the specified project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByConfig --> <command:syntaxItem> <maml:name>Add-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceConfig</maml:name> <maml:description> <maml:para>The instance resource, which can be created with New-GcSqlInstanceConfig.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Add-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The instance resource, which can be created with New-GcSqlInstanceConfig.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceConfig</maml:name> <maml:description> <maml:para>The instance resource, which can be created with New-GcSqlInstanceConfig.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The instance resource, which can be created with New-GcSqlInstanceConfig.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The instance resource, which can be created with New-GcSqlInstanceConfig.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DatabaseInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcSqlInstance $myInstance</dev:code> <dev:remarks> <maml:para>Adds the instance represented by $myInstance to our project set in gcloud config.</maml:para> <maml:para>If successful, the command returns a resource for the added instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GcSqlInstance "gootoso" -Project "myproject"</dev:code> <dev:remarks> <maml:para>Adds a default instance named "gootoso" to the project "myproject"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Setting up Instances] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/setup)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: ConvertTo-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>ConvertTo-GcSqlInstance</command:name> <command:verb>ConvertTo</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Convert a Cloud SQL Replica to an SQL Instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert the specified Cloud SQL Replica to a stand-alone Instance.</maml:para> <maml:para>If a Project is specified, it will promote the specified Replica in that Project. Otherwise, promotes the replica in the Cloud SDK config project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>ConvertTo-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to promote.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>ConvertTo-GcSqlInstance</maml:name> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to promote.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to promote.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to promote.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to promote.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> ConvertTo-GcSqlInstance -Project "testing" -Replica "testRepl1"</dev:code> <dev:remarks> <maml:para>Convert the SQL Replica "testRepl1" from the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Replica Instances]</maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/replica)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Export-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-GcSqlInstance</command:name> <command:verb>Export</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump or CSV file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports data from the specified Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump or CSV file. Defaults to a SQL file, but if the CSV Parameter set is used it will export as a CSV file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SQL --> <command:syntaxItem> <maml:name>Export-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified. ///</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to have data exported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloudStorageDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CloudStorageDestination</maml:name> <maml:description> <maml:para>The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form "gs://bucketName/fileName."</maml:para> <maml:para>If the file already exists, the operation will fail.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SchemaOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SchemaOnly</maml:name> <maml:description> <maml:para>Export only schemas.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Database</maml:name> <maml:description> <maml:para>Databases (for example, "guestbook" or "orders") from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If exporting as CSV and selectQuery also specifies the database, this field will be ignored.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: CSV --> <command:syntaxItem> <maml:name>Export-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified. ///</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to have data exported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloudStorageDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CloudStorageDestination</maml:name> <maml:description> <maml:para>The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form "gs://bucketName/fileName."</maml:para> <maml:para>If the file already exists, the operation will fail.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectQuery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>SelectQuery</maml:name> <maml:description> <maml:para>The select query used to extract the data. If this is used, a CSV file will be exported, rather than SQL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Database</maml:name> <maml:description> <maml:para>Databases (for example, "guestbook" or "orders") from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If exporting as CSV and selectQuery also specifies the database, this field will be ignored.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified. ///</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to have data exported.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloudStorageDestination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CloudStorageDestination</maml:name> <maml:description> <maml:para>The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form "gs://bucketName/fileName."</maml:para> <maml:para>If the file already exists, the operation will fail.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SchemaOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SchemaOnly</maml:name> <maml:description> <maml:para>Export only schemas.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectQuery --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>SelectQuery</maml:name> <maml:description> <maml:para>The select query used to extract the data. If this is used, a CSV file will be exported, rather than SQL.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Database</maml:name> <maml:description> <maml:para>Databases (for example, "guestbook" or "orders") from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If exporting as CSV and selectQuery also specifies the database, this field will be ignored.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Export-GcSqlInstance "myInstance" "gs://bucket/file.gz"</dev:code> <dev:remarks> <maml:para>Exports the databases inside the instance "myInstance" to the Cloud Storage bucket file "gs://bucket/file.gz" as a MySQL dump file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Export-GcSqlInstance "myInstance" "gs://bucket/file.csv" "SELECT * FROM data.table"</dev:code> <dev:remarks> <maml:para>Exports the databases inside the instance "myInstance" to the Cloud Storage bucket file "gs://bucket/file.csv" as a CSV file with the select query "SELECT * FROM data.table"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Export-GcSqlInstance "myInstance" "gs://bucket/file.csv" -Database "myData","myData2"</dev:code> <dev:remarks> <maml:para>Exports the databases "myData" and "myData2" inside the instance "myInstance" to the Cloud Storage bucket file "gs://bucket/file.gz" as a MySQL dump file.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [How-To: Importing and Exporting] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/import-export)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Overview of Importing and Exporting] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/import-export/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlInstance</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Retrieves a resource containing information about a Cloud SQL instance, or lists all instances in a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Single --> <command:syntaxItem> <maml:name>Get-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DatabaseInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlInstance</dev:code> <dev:remarks> <maml:para>Gets a list of instances in the project set in gcloud config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlInstance "myInstance"</dev:code> <dev:remarks> <maml:para>Gets a resource for the instance named "myInstance" in our project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-GcSqlInstance</command:name> <command:verb>Import</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Imports data into a Cloud SQL instance from a MySQL dump or CSV file stored either in a Google Cloud Storage bucket or on your local machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Imports data into a Cloud SQL instance from a MySQL dump or CSV file stored either in a Google Cloud Storage bucket or on your local machine. Only one database may be imported from a MySQL file, and only one table may be imported from a CSV file.</maml:para> <maml:para>WARNING: Standard charging rates apply if a file is imported from your local machine. A Google Cloud Storage bucket will be set up, uploaded to, and imported from during the import process. It is deleted after the upload and/or import process fails or is completed</maml:para> </maml:description> <command:syntax> <!-- Parameter set: CSV --> <command:syntaxItem> <maml:name>Import-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the active cloud sdk config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to have data exported to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImportFilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFilePath</maml:name> <maml:description> <maml:para>The path to the file where the import file is stored. A Google Cloud Storage path is in the form "gs://bucketName/fileName".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database inside of the Instance (for example, "guestbook" or "orders") to which the import is made. It must already exist.</maml:para> <maml:para>If filetype is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. The filetype of the file is assumed to be the corresponding parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationTable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table to which CSV data is imported. Must be specified for a CSV file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Column --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Column</maml:name> <maml:description> <maml:para>The columns of the CSV data to import. If not specified, all columns are imported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the active cloud sdk config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to have data exported to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImportFilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFilePath</maml:name> <maml:description> <maml:para>The path to the file where the import file is stored. A Google Cloud Storage path is in the form "gs://bucketName/fileName".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Database --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Database</maml:name> <maml:description> <maml:para>The database inside of the Instance (for example, "guestbook" or "orders") to which the import is made. It must already exist.</maml:para> <maml:para>If filetype is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. The filetype of the file is assumed to be the corresponding parameter set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationTable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table to which CSV data is imported. Must be specified for a CSV file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Column --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Column</maml:name> <maml:description> <maml:para>The columns of the CSV data to import. If not specified, all columns are imported.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Import-GcSqlInstance "myInstance" "gs://bucket/file" "myData"</dev:code> <dev:remarks> <maml:para>Imports the MySQL dump file at "gs://bucket/file" into the already existing database "myData" in the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Import-GcSqlInstance "myInstance" "gs://bucket/file.csv" "myData" "myTable"</dev:code> <dev:remarks> <maml:para>Imports the CSV file at "gs://bucket/file.csv" into the table "myTable" in the already existing database "myData" in the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Import-GcSqlInstance "myInstance" "C:\Users\Bob\file.csv" "myData" "myTable" </dev:code> <dev:remarks> <maml:para>Imports the CSV file at "C:\Users\Bob\file.csv" into the table "myTable" in the already existing database "myData" in the instance "myInstance".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [How-To: Importing and Exporting] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/import-export)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Overview of Importing and Exporting] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/import-export/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcSqlInstance</command:name> <command:verb>Remove</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Deletes a Cloud SQL instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified Cloud SQL instance. Warning: This deletes all data inside of it as well.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Remove-GcSqlInstance</maml:name> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to remove.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to be deleted.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to remove.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the instance to be deleted.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcSqlInstance "myInstance"</dev:code> <dev:remarks> <maml:para>Removes the instance called "myInstance" from our project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Remove-GcSqlInstance $myInstance</dev:code> <dev:remarks> <maml:para>Removes the instance represented by the resource $myInstance from our project.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restart-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-GcSqlInstance</command:name> <command:verb>Restart</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Restarts a Cloud SQL Instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restarts the specified Cloud SQL Instance.</maml:para> <maml:para>If a Project is specified, it will restart the specified Instance in that project. Otherwise, the Project defaults to the Cloud SDK config for properties.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Restart-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to restart.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Restart-GcSqlInstance</maml:name> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to restart.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to restart.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to restart.</maml:para> <maml:para>This is an alias of the Instance parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name,Id"> <maml:name>Id</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to restart.</maml:para> <maml:para>This is an alias of the Instance parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to restart.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to restart.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Restart-GcSqlInstance -Project "testing" -Instance "test1"</dev:code> <dev:remarks> <maml:para>Restart the SQL instance "test1" from the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-GcSqlInstance --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-GcSqlInstance</command:name> <command:verb>Update</command:verb> <command:noun>GcSqlInstance</command:noun> <maml:description> <maml:para>Updates settings of a Cloud SQL instance, or patches them.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates settings of the specified Cloud SQL instance, or patches them. If “Update” is true, it will update them. Otherwise it patches.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Update-GcSqlInstance</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to be updated/patched.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingsVersion --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingsVersion</maml:name> <maml:description> <maml:para>The version of instance settings. Required field to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for the instance and do not try to update this value.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Update --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>If true, updates the instance with only the specified parameters. All other parameters revert back to the default. If false, follows patch semantics and patches the instance. Unspecified parameters will stay the same.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tier --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tier</maml:name> <maml:description> <maml:para>The tier of service for this instance, for example "db-n1-standard-1". Pricing information is available at https://cloud.google.com/sql/pricing. Get-GcSqlTiers will also tell you what tiers are available for your project. If not specified, this will be acquired from the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseReplicationEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseReplicationEnabled</maml:name> <maml:description> <maml:para>Configuration specific to read replica instances. Indicates whether replication is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Can be ALWAYS, or NEVER.</maml:para> <maml:para>Possible values: ALWAYS, NONE</maml:para> </maml:description> <command:parameterValue required="true">ActivationPolicy</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+ActivationPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ALWAYS</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ALWAYS</command:parameterValue> <command:parameterValue required="false" variableLength="false">NONE</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BackupBinaryLogEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupBinaryLogEnabled</maml:name> <maml:description> <maml:para>Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEnabled</maml:name> <maml:description> <maml:para>Whether the backup configuration is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupStartTime</maml:name> <maml:description> <maml:para>Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataDiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskSizeGb</maml:name> <maml:description> <maml:para>The size of data disk, in GB. The data disk size minimum is 10 GB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseFlag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseFlag</maml:name> <maml:description> <maml:para>The database flags passed to the instance at startup.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseFlags[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseFlags[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigAuthorizedNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigAuthorizedNetwork</maml:name> <maml:description> <maml:para>The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. "192.168.100.0/24").</maml:para> </maml:description> <command:parameterValue required="true">AclEntry[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.AclEntry[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigIpv4Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigIpv4Enabled</maml:name> <maml:description> <maml:para>Whether the instance should be assigned an IP address or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IpConfigRequireSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigRequireSsl</maml:name> <maml:description> <maml:para>Whether the mysqld should default to “REQUIRE X509” for users connecting over IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocationPreferenceFollowGae --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceFollowGae</maml:name> <maml:description> <maml:para>The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocationPreferenceZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceZone</maml:name> <maml:description> <maml:para>The preferred Compute Engine Zone (e.g. us-central1-a, us-central1-b, etc.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaintenanceWindowDay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDay</maml:name> <maml:description> <maml:para>Day of the week (1-7) starting monday that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaintenanceWindowHour --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowHour</maml:name> <maml:description> <maml:para>Hour of day (0-23) that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageAutoResize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAutoResize</maml:name> <maml:description> <maml:para>Configuration to increase storage size automatically. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>The type of data disk: PD_SSD (default) or PD_HDD. Applies only to Second Generation instances.</maml:para> <maml:para>Possible values: PD_SSD, PD_HDD</maml:para> </maml:description> <command:parameterValue required="true">DataDiskType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+DataDiskType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PD_SSD</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PD_SSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">PD_HDD</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Update-GcSqlInstance</maml:name> <!-- Parameter: SettingsVersion --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingsVersion</maml:name> <maml:description> <maml:para>The version of instance settings. Required field to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for the instance and do not try to update this value.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to update/patch.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Update --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>If true, updates the instance with only the specified parameters. All other parameters revert back to the default. If false, follows patch semantics and patches the instance. Unspecified parameters will stay the same.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tier --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tier</maml:name> <maml:description> <maml:para>The tier of service for this instance, for example "db-n1-standard-1". Pricing information is available at https://cloud.google.com/sql/pricing. Get-GcSqlTiers will also tell you what tiers are available for your project. If not specified, this will be acquired from the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseReplicationEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseReplicationEnabled</maml:name> <maml:description> <maml:para>Configuration specific to read replica instances. Indicates whether replication is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Can be ALWAYS, or NEVER.</maml:para> <maml:para>Possible values: ALWAYS, NONE</maml:para> </maml:description> <command:parameterValue required="true">ActivationPolicy</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+ActivationPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ALWAYS</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ALWAYS</command:parameterValue> <command:parameterValue required="false" variableLength="false">NONE</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BackupBinaryLogEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupBinaryLogEnabled</maml:name> <maml:description> <maml:para>Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEnabled</maml:name> <maml:description> <maml:para>Whether the backup configuration is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupStartTime</maml:name> <maml:description> <maml:para>Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataDiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskSizeGb</maml:name> <maml:description> <maml:para>The size of data disk, in GB. The data disk size minimum is 10 GB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseFlag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseFlag</maml:name> <maml:description> <maml:para>The database flags passed to the instance at startup.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseFlags[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseFlags[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigAuthorizedNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigAuthorizedNetwork</maml:name> <maml:description> <maml:para>The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. "192.168.100.0/24").</maml:para> </maml:description> <command:parameterValue required="true">AclEntry[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.AclEntry[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigIpv4Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigIpv4Enabled</maml:name> <maml:description> <maml:para>Whether the instance should be assigned an IP address or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IpConfigRequireSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigRequireSsl</maml:name> <maml:description> <maml:para>Whether the mysqld should default to “REQUIRE X509” for users connecting over IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocationPreferenceFollowGae --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceFollowGae</maml:name> <maml:description> <maml:para>The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocationPreferenceZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceZone</maml:name> <maml:description> <maml:para>The preferred Compute Engine Zone (e.g. us-central1-a, us-central1-b, etc.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaintenanceWindowDay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDay</maml:name> <maml:description> <maml:para>Day of the week (1-7) starting monday that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaintenanceWindowHour --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowHour</maml:name> <maml:description> <maml:para>Hour of day (0-23) that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageAutoResize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAutoResize</maml:name> <maml:description> <maml:para>Configuration to increase storage size automatically. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>The type of data disk: PD_SSD (default) or PD_HDD. Applies only to Second Generation instances.</maml:para> <maml:para>Possible values: PD_SSD, PD_HDD</maml:para> </maml:description> <command:parameterValue required="true">DataDiskType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+DataDiskType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PD_SSD</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PD_SSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">PD_HDD</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name of the instance to be updated/patched.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingsVersion --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingsVersion</maml:name> <maml:description> <maml:para>The version of instance settings. Required field to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for the instance and do not try to update this value.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to update/patch.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Update --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Update</maml:name> <maml:description> <maml:para>If true, updates the instance with only the specified parameters. All other parameters revert back to the default. If false, follows patch semantics and patches the instance. Unspecified parameters will stay the same.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tier --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tier</maml:name> <maml:description> <maml:para>The tier of service for this instance, for example "db-n1-standard-1". Pricing information is available at https://cloud.google.com/sql/pricing. Get-GcSqlTiers will also tell you what tiers are available for your project. If not specified, this will be acquired from the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseReplicationEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseReplicationEnabled</maml:name> <maml:description> <maml:para>Configuration specific to read replica instances. Indicates whether replication is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Can be ALWAYS, or NEVER.</maml:para> <maml:para>Possible values: ALWAYS, NONE</maml:para> </maml:description> <command:parameterValue required="true">ActivationPolicy</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+ActivationPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ALWAYS</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ALWAYS</command:parameterValue> <command:parameterValue required="false" variableLength="false">NONE</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BackupBinaryLogEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupBinaryLogEnabled</maml:name> <maml:description> <maml:para>Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEnabled</maml:name> <maml:description> <maml:para>Whether the backup configuration is enabled or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: BackupStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupStartTime</maml:name> <maml:description> <maml:para>Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataDiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskSizeGb</maml:name> <maml:description> <maml:para>The size of data disk, in GB. The data disk size minimum is 10 GB.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseFlag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseFlag</maml:name> <maml:description> <maml:para>The database flags passed to the instance at startup.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseFlags[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseFlags[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigAuthorizedNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigAuthorizedNetwork</maml:name> <maml:description> <maml:para>The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. "192.168.100.0/24").</maml:para> </maml:description> <command:parameterValue required="true">AclEntry[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.AclEntry[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigIpv4Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigIpv4Enabled</maml:name> <maml:description> <maml:para>Whether the instance should be assigned an IP address or not.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IpConfigRequireSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigRequireSsl</maml:name> <maml:description> <maml:para>Whether the mysqld should default to “REQUIRE X509” for users connecting over IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocationPreferenceFollowGae --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceFollowGae</maml:name> <maml:description> <maml:para>The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocationPreferenceZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceZone</maml:name> <maml:description> <maml:para>The preferred Compute Engine Zone (e.g. us-central1-a, us-central1-b, etc.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaintenanceWindowDay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDay</maml:name> <maml:description> <maml:para>Day of the week (1-7) starting monday that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaintenanceWindowHour --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowHour</maml:name> <maml:description> <maml:para>Hour of day (0-23) that the instance may be restarted for maintenance purposes. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageAutoResize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAutoResize</maml:name> <maml:description> <maml:para>Configuration to increase storage size automatically. Applies only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>The type of data disk: PD_SSD (default) or PD_HDD. Applies only to Second Generation instances.</maml:para> <maml:para>Possible values: PD_SSD, PD_HDD</maml:para> </maml:description> <command:parameterValue required="true">DataDiskType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.UpdateGcSqlInstanceCmdlet+DataDiskType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PD_SSD</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PD_SSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">PD_HDD</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the instance we want to update/patch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DatabaseInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Update-GcSqlInstance "myInstance" ` 15 -MaintenanceWindowDay 1 -MaintenanceWindowHour "22:00" -Project "testing" </dev:code> <dev:remarks> <maml:para>Patches the SQL Instance "myInstance" (with setting version of 15) so that it can have maintenance on Monday at 22:00.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Update-GcSqlInstance "myInstance" 18 -Update</dev:code> <dev:remarks> <maml:para>Updates the SQL Instance "myInstance" (with and setting version of 18) so that its settings default.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restore-GcSqlInstanceBackup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restore-GcSqlInstanceBackup</command:name> <command:verb>Restore</command:verb> <command:noun>GcSqlInstanceBackup</command:noun> <maml:description> <maml:para>Restores a backup of a Cloud SQL Instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores the specified backup of the specified Cloud SQL Instance.</maml:para> <maml:para>If a BackupInstance is specified, it will restore the specified backup run of that instance to the specified Instance. Otherwise, it will assume the backup instance is the same as the specified Instance.</maml:para> <maml:para>If a Project is specified, it will restore the specified backup in that project. Otherwise, restores the backup in the Cloud SDK config project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Restore-GcSqlInstanceBackup</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instances to backup to and from reside. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BackupRunId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>BackupRunId</maml:name> <maml:description> <maml:para>The id of the BackupRun to restore to.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of Instance we are restoring the backup to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BackupInstance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupInstance</maml:name> <maml:description> <maml:para>The name/ID of Instance we are backing up from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Restore-GcSqlInstanceBackup</maml:name> <!-- Parameter: BackupRunId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>BackupRunId</maml:name> <maml:description> <maml:para>The id of the BackupRun to restore to.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we are restoring the backup to.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BackupInstance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupInstance</maml:name> <maml:description> <maml:para>The name/ID of Instance we are backing up from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instances to backup to and from reside. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BackupRunId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>BackupRunId</maml:name> <maml:description> <maml:para>The id of the BackupRun to restore to.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of Instance we are restoring the backup to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we are restoring the backup to.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BackupInstance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupInstance</maml:name> <maml:description> <maml:para>The name/ID of Instance we are backing up from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we are restoring the backup to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Restore-GcSqlInstanceBackup -Project "testing" -BackupRunId 1243244 -Instance "testRepl1"</dev:code> <dev:remarks> <maml:para>Restores backup run with id 0 of the SQL Instance "testRepl1" from the Project "testing" to the same SQL Instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Restore-GcSqlInstanceBackup -Project "testing" -BackupRunId 0 -Instance "testRepl1" ` -BackupInstance "testRepl2"</dev:code> <dev:remarks> <maml:para>Restores backup run with id 0 of the SQL Instance "testRepl2" from the Project "testing" to the SQL Instance "testRepl1" (which must be in the same project).</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Managing Backups] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/backup)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Overview of Backups] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/backup-recovery/backups)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Overview of Restoring an instance] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/backup-recovery/restore)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcSqlInstanceConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcSqlInstanceConfig</command:name> <command:verb>New</command:verb> <command:noun>GcSqlInstanceConfig</command:noun> <maml:description> <maml:para>Makes a new Google Cloud SQL instance description.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Makes a new Google Cloud SQL instance description. Use Add-GcSqlInstance to instantiate the instance within a project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcSqlInstanceConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Cloud SQL instance. This does not include the project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SettingConfig</maml:name> <maml:description> <maml:para>The user settings. Can be created with New-GcSqlSettingConfig.</maml:para> </maml:description> <command:parameterValue required="true">Settings</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Settings</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseVer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseVer</maml:name> <maml:description> <maml:para>The database engine type and version. This cannot be changed after instance creation.</maml:para> <maml:para>e.g. "MYSQL_5_6" or "MYSQL_5_7". Defaults to "MYSQL_5_7".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MYSQL_5_7</dev:defaultValue> </command:parameter> <!-- Parameter: MasterInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterInstanceName</maml:name> <maml:description> <maml:para>The name of the instance which will act as master in the replication setup. Should only be used for read-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FailoverReplica --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FailoverReplica</maml:name> <maml:description> <maml:para>The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. This property is applicable only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicaConfig --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ReplicaConfig</maml:name> <maml:description> <maml:para>The ReplicaConfiguration created by New-GcSqlInstanceReplicaConfig.</maml:para> </maml:description> <command:parameterValue required="true">ReplicaConfiguration</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.ReplicaConfiguration</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The geographical region. Can be us-central1, asia-east1, or europe-west1.</maml:para> <maml:para>Defaults to us-central1 and cannot be changed after instance creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>us-central1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Cloud SQL instance. This does not include the project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SettingConfig</maml:name> <maml:description> <maml:para>The user settings. Can be created with New-GcSqlSettingConfig.</maml:para> </maml:description> <command:parameterValue required="true">Settings</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Settings</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseVer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseVer</maml:name> <maml:description> <maml:para>The database engine type and version. This cannot be changed after instance creation.</maml:para> <maml:para>e.g. "MYSQL_5_6" or "MYSQL_5_7". Defaults to "MYSQL_5_7".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MYSQL_5_7</dev:defaultValue> </command:parameter> <!-- Parameter: MasterInstanceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterInstanceName</maml:name> <maml:description> <maml:para>The name of the instance which will act as master in the replication setup. Should only be used for read-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FailoverReplica --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FailoverReplica</maml:name> <maml:description> <maml:para>The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. This property is applicable only to Second Generation instances.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicaConfig --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ReplicaConfig</maml:name> <maml:description> <maml:para>The ReplicaConfiguration created by New-GcSqlInstanceReplicaConfig.</maml:para> </maml:description> <command:parameterValue required="true">ReplicaConfiguration</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.ReplicaConfiguration</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Region</maml:name> <maml:description> <maml:para>The geographical region. Can be us-central1, asia-east1, or europe-west1.</maml:para> <maml:para>Defaults to us-central1 and cannot be changed after instance creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>us-central1</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Settings</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The user settings. Can be created with New-GcSqlSettingConfig.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.ReplicaConfiguration</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ReplicaConfiguration created by New-GcSqlInstanceReplicaConfig.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DatabaseInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcSqlInstanceConfig "myInstance" $mySettings</dev:code> <dev:remarks> <maml:para>Creates an instance resource with name "myInstance" and settings $mySettings</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcSqlInstanceConfig "myInstance" $mySettings -ReplicaConfig $myRepl</dev:code> <dev:remarks> <maml:para>Creates an instance resource with name "myInstance", settings $mySettings, and replica configuration $myRepl</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [How-To: Setting up Instances] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/setup)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Instance Settings] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/instance-settings)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Invoke-GcSqlInstanceFailover --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-GcSqlInstanceFailover</command:name> <command:verb>Invoke</command:verb> <command:noun>GcSqlInstanceFailover</command:noun> <maml:description> <maml:para>Failover a Cloud SQL Instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Failover the specified Cloud SQL Instance to its failover replica instance.</maml:para> <maml:para>If a Project is specified, it will failover the specified Instance in that Project. Otherwise, failsover the Instance in the Cloud SDK config project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Invoke-GcSqlInstanceFailover</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the Instance resides. Defaults to the Cloud SDK config project if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to failover.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingsVersion --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingsVersion</maml:name> <maml:description> <maml:para>The current settings version of the Instance.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Invoke-GcSqlInstanceFailover</maml:name> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to failover.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the Instance resides. Defaults to the Cloud SDK config project if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>The name/ID of the Instance resource to failover.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to failover.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SettingsVersion --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingsVersion</maml:name> <maml:description> <maml:para>The current settings version of the Instance.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Instance we want to failover.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Invoke-GcSqlInstanceFailover -Project "testing" -Instance "test1"</dev:code> <dev:remarks> <maml:para>Failover the SQL Instance "test1" in the Project "testing."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Invoke-GcSqlInstanceFailover -Project "testing" -Instance "test1" - SettingsVersion 3</dev:code> <dev:remarks> <maml:para>Failover the SQL Instance "test1" with current settings version 3 in the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Replica Instances]</maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/replica)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcSqlInstanceReplicaConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcSqlInstanceReplicaConfig</command:name> <command:verb>New</command:verb> <command:noun>GcSqlInstanceReplicaConfig</command:noun> <maml:description> <maml:para>Creates a configuration for a replicaConfiguration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a configuration for a replicaConfiguration. Can be pipelined into New-GcSqlInstanceConfig.</maml:para> <maml:para>NOTE: If any parameter is incorrect/invalid, this cmdlet not fail. You will only receive an error once you try to update or add an instance with this configuration to your project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcSqlInstanceReplicaConfig</maml:name> <!-- Parameter: FailoverTarget --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FailoverTarget</maml:name> <maml:description> <maml:para>Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.</maml:para> <maml:para>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlCaCert --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlCaCert</maml:name> <maml:description> <maml:para>PEM representation of the trusted CA’s x509 certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlClientCert --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlClientCert</maml:name> <maml:description> <maml:para>PEM representation of the slave’s x509 certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlClientKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlClientKey</maml:name> <maml:description> <maml:para>PEM representation of the slave’s private key. The corresponding public key is encoded in the client’s certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlRetryInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlRetryInterval</maml:name> <maml:description> <maml:para>Seconds to wait between connect retries. The default is 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlDumpPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlDumpPath</maml:name> <maml:description> <maml:para>Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form "gs://bucketName/fileName". Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlHeartbeatPeriod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlHeartbeatPeriod</maml:name> <maml:description> <maml:para>Interval in milliseconds between replication heartbeats. Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20000</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlPassword</maml:name> <maml:description> <maml:para>The password for the replication connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlSslCipher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlSslCipher</maml:name> <maml:description> <maml:para>A list of permissible ciphers to use for SSL encryption.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlUser</maml:name> <maml:description> <maml:para>The username for the replication connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlVerifyCertificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlVerifyCertificate</maml:name> <maml:description> <maml:para>Whether or not to check the master’s Common Name value in the certificate that it sends during the SSL handshake.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FailoverTarget --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FailoverTarget</maml:name> <maml:description> <maml:para>Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance.</maml:para> <maml:para>Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlCaCert --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlCaCert</maml:name> <maml:description> <maml:para>PEM representation of the trusted CA’s x509 certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlClientCert --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlClientCert</maml:name> <maml:description> <maml:para>PEM representation of the slave’s x509 certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlClientKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlClientKey</maml:name> <maml:description> <maml:para>PEM representation of the slave’s private key. The corresponding public key is encoded in the client’s certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlRetryInterval --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlRetryInterval</maml:name> <maml:description> <maml:para>Seconds to wait between connect retries. The default is 60 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>60</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlDumpPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlDumpPath</maml:name> <maml:description> <maml:para>Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form "gs://bucketName/fileName". Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlHeartbeatPeriod --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlHeartbeatPeriod</maml:name> <maml:description> <maml:para>Interval in milliseconds between replication heartbeats. Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>20000</dev:defaultValue> </command:parameter> <!-- Parameter: MySqlPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlPassword</maml:name> <maml:description> <maml:para>The password for the replication connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlSslCipher --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlSslCipher</maml:name> <maml:description> <maml:para>A list of permissible ciphers to use for SSL encryption.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlUser</maml:name> <maml:description> <maml:para>The username for the replication connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MySqlVerifyCertificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MySqlVerifyCertificate</maml:name> <maml:description> <maml:para>Whether or not to check the master’s Common Name value in the certificate that it sends during the SSL handshake.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ReplicaConfiguration --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.ReplicaConfiguration</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcSqlInstanceReplicaConfig</dev:code> <dev:remarks> <maml:para>Creates a basic replica configuration resource with default values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcSqlInstanceReplicaConfig -MySqlRetryInterval 10</dev:code> <dev:remarks> <maml:para>Creates a basic replica configuration resource with a retry interval of 10 seconds.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Setting up Instances] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/setup)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Replica Instances] </maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/replica)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Replication Options] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/replication/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Replication Requirements and Tips] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/replication/tips)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GcSqlOperation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlOperation</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlOperation</command:noun> <maml:description> <maml:para>Retrieves an instance operation that has been performed on an instance, or a list of operations used on the instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves an instance operation that has been performed on an instance, or a list of operations used on the instance. This is decided by if you provide a Name or not.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Single --> <command:syntaxItem> <maml:name>Get-GcSqlOperation</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Instance operation ID/name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-GcSqlOperation</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Instance operation ID/name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Operation --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Operation</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlOperation -Instance "myInstance"</dev:code> <dev:remarks> <maml:para>Gets a list of operations done on the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlOperation -Name "1d402..."</dev:code> <dev:remarks> <maml:para>Gets a resource for the operation with ID "1d402...".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-GcSqlReplica --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-GcSqlReplica</command:name> <command:verb>Start</command:verb> <command:noun>GcSqlReplica</command:noun> <maml:description> <maml:para>Starts a Cloud SQL Replica.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts the specified Cloud SQL Replica.</maml:para> <maml:para>If a Project is specified, it will start the specified Replica in that Project. Otherwise, starts the replica in the Cloud SDK config project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Start-GcSqlReplica</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to start.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Start-GcSqlReplica</maml:name> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to start.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to start.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to start.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to start.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Start-GcSqlReplica -Project "testing" -Replica "testRepl1"</dev:code> <dev:remarks> <maml:para>Start the SQL Replica "testRepl1" from the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Replica Instances]</maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/replica)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Stop-GcSqlReplica --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-GcSqlReplica</command:name> <command:verb>Stop</command:verb> <command:noun>GcSqlReplica</command:noun> <maml:description> <maml:para>Stops a Cloud SQL Replica.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops the specified Cloud SQL Replica.</maml:para> <maml:para>If a Project is specified, it will stop the specified Replica in that Project. Otherwise, stops the replica in the Cloud SDK config project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Stop-GcSqlReplica</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to stop.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Stop-GcSqlReplica</maml:name> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to stop.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project in which the instance Replica resides. Defaults to the Cloud SDK config for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replica --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Replica</maml:name> <maml:description> <maml:para>The name/ID of the Replica resource to stop.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicaObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReplicaObject</maml:name> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to stop.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DatabaseInstance that describes the Replica we want to stop.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Stop-GcSqlReplica -Project "testing" -Replica "testRepl1"</dev:code> <dev:remarks> <maml:para>Stop the SQL Replica "testRepl1" from the Project "testing."</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>[Replica Instances]</maml:linkText> <maml:uri>(https://cloud.google.com/tools/powershell/docs/sql/replica)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GcSqlSettingConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GcSqlSettingConfig</command:name> <command:verb>New</command:verb> <command:noun>GcSqlSettingConfig</command:noun> <maml:description> <maml:para>Makes a new Google Cloud SQL Instance Settings configuration for a second generation instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a settings configuration specified by the passed in parameters. Meant to be only for Second generation instances. Can be pipelined into New-GcSqlInstanceConfig.</maml:para> <maml:para>NOTE: If any parameter is incorrect/invalid, this cmdlet not fail. You will only receive an error once you try to update or add an instance with this configuration to your project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GcSqlSettingConfig</maml:name> <!-- Parameter: TierConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>TierConfig</maml:name> <maml:description> <maml:para>The tier of service for this instance, for example "db-n1-standard-1". Pricing information is available at https://cloud.google.com/sql/pricing. Get-GcSqlTiers will also tell you what tiers are available for your project. Defaults to "db-n1-standard-1"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>db-n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Can be ALWAYS, or NEVER. Defaults to ALWAYS</maml:para> <maml:para>Possible values: ALWAYS, NONE</maml:para> </maml:description> <command:parameterValue required="true">ActivationPolicy</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.NewGcSqlSettingConfigCmdlet+ActivationPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ALWAYS</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ALWAYS</command:parameterValue> <command:parameterValue required="false" variableLength="false">NONE</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BinaryLogEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryLogEnabled</maml:name> <maml:description> <maml:para>Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. Defaults to true for non-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: BackupConfigEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupConfigEnabled</maml:name> <maml:description> <maml:para>Whether the backup configuration is enabled or not. Defaults to true for non-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: BackupConfigStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupConfigStartTime</maml:name> <maml:description> <maml:para>Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM Defaults to 22:00</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>22:00</dev:defaultValue> </command:parameter> <!-- Parameter: DataDiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskSizeGb</maml:name> <maml:description> <maml:para>The size of data disk, in GB. The data disk size minimum is 10 GB. (Defaults to 50).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseFlag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseFlag</maml:name> <maml:description> <maml:para>The database flags passed to the instance at startup. Defaults to an empty list.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseFlags[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseFlags[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigAuthorizedNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigAuthorizedNetwork</maml:name> <maml:description> <maml:para>The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. "192.168.100.0/24"). May include other ipConfiguration params, but unsure. Defaults to an empty list.</maml:para> </maml:description> <command:parameterValue required="true">AclEntry[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.AclEntry[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigIpv4Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigIpv4Enabled</maml:name> <maml:description> <maml:para>Whether the instance should be assigned an IP address or not. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IpConfigRequireSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigRequireSsl</maml:name> <maml:description> <maml:para>Whether the mysqld should default to “REQUIRE X509” for users connecting over IP. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocationPreferenceFollowGae --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceFollowGae</maml:name> <maml:description> <maml:para>The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocationPreferenceZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceZone</maml:name> <maml:description> <maml:para>The preferred Compute Engine Zone (e.g. us-central1-a, us-central1-b, etc.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaintenanceWindowDay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDay</maml:name> <maml:description> <maml:para>Day of the week (1-7) starting monday that the instance may be restarted for maintenance purposes. Defaults to 5 (Friday).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: MaintenanceWindowHour --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowHour</maml:name> <maml:description> <maml:para>Hour of day (0-23) that the instance may be restarted for maintenance purposes. Defaults to 22;</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>22</dev:defaultValue> </command:parameter> <!-- Parameter: StorageAutoResize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAutoResize</maml:name> <maml:description> <maml:para>Configuration to increase storage size automatically. The default value is false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>The type of data disk: PD_SSD (default) or PD_HDD.</maml:para> <maml:para>Possible values: PD_SSD, PD_HDD</maml:para> </maml:description> <command:parameterValue required="true">DataDiskType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.NewGcSqlSettingConfigCmdlet+DataDiskType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PD_SSD</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PD_SSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">PD_HDD</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TierConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>TierConfig</maml:name> <maml:description> <maml:para>The tier of service for this instance, for example "db-n1-standard-1". Pricing information is available at https://cloud.google.com/sql/pricing. Get-GcSqlTiers will also tell you what tiers are available for your project. Defaults to "db-n1-standard-1"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>db-n1-standard-1</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Can be ALWAYS, or NEVER. Defaults to ALWAYS</maml:para> <maml:para>Possible values: ALWAYS, NONE</maml:para> </maml:description> <command:parameterValue required="true">ActivationPolicy</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.NewGcSqlSettingConfigCmdlet+ActivationPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ALWAYS</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ALWAYS</command:parameterValue> <command:parameterValue required="false" variableLength="false">NONE</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: BinaryLogEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BinaryLogEnabled</maml:name> <maml:description> <maml:para>Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well. Defaults to true for non-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: BackupConfigEnabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupConfigEnabled</maml:name> <maml:description> <maml:para>Whether the backup configuration is enabled or not. Defaults to true for non-replica instances.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: BackupConfigStartTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupConfigStartTime</maml:name> <maml:description> <maml:para>Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM Defaults to 22:00</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>22:00</dev:defaultValue> </command:parameter> <!-- Parameter: DataDiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskSizeGb</maml:name> <maml:description> <maml:para>The size of data disk, in GB. The data disk size minimum is 10 GB. (Defaults to 50).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseFlag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseFlag</maml:name> <maml:description> <maml:para>The database flags passed to the instance at startup. Defaults to an empty list.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseFlags[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseFlags[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigAuthorizedNetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigAuthorizedNetwork</maml:name> <maml:description> <maml:para>The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. "192.168.100.0/24"). May include other ipConfiguration params, but unsure. Defaults to an empty list.</maml:para> </maml:description> <command:parameterValue required="true">AclEntry[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.AclEntry[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IpConfigIpv4Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigIpv4Enabled</maml:name> <maml:description> <maml:para>Whether the instance should be assigned an IP address or not. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IpConfigRequireSsl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IpConfigRequireSsl</maml:name> <maml:description> <maml:para>Whether the mysqld should default to “REQUIRE X509” for users connecting over IP. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocationPreferenceFollowGae --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceFollowGae</maml:name> <maml:description> <maml:para>The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocationPreferenceZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocationPreferenceZone</maml:name> <maml:description> <maml:para>The preferred Compute Engine Zone (e.g. us-central1-a, us-central1-b, etc.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaintenanceWindowDay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDay</maml:name> <maml:description> <maml:para>Day of the week (1-7) starting monday that the instance may be restarted for maintenance purposes. Defaults to 5 (Friday).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: MaintenanceWindowHour --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowHour</maml:name> <maml:description> <maml:para>Hour of day (0-23) that the instance may be restarted for maintenance purposes. Defaults to 22;</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>22</dev:defaultValue> </command:parameter> <!-- Parameter: StorageAutoResize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageAutoResize</maml:name> <maml:description> <maml:para>Configuration to increase storage size automatically. The default value is false.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DiskType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>The type of data disk: PD_SSD (default) or PD_HDD.</maml:para> <maml:para>Possible values: PD_SSD, PD_HDD</maml:para> </maml:description> <command:parameterValue required="true">DataDiskType</command:parameterValue> <dev:type> <maml:name>Google.PowerShell.Sql.NewGcSqlSettingConfigCmdlet+DataDiskType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PD_SSD</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PD_SSD</command:parameterValue> <command:parameterValue required="false" variableLength="false">PD_HDD</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Settings --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Settings</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GcSqlSettingConfig "db-n1-standard-1"</dev:code> <dev:remarks> <maml:para>Creates a settings resource with tier "db-n1-standard-1".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GcSqlSettingConfig "db-n1-standard-1" -MaintenanceWindowDay 1 -MaintenanceWindowHour "22:00"</dev:code> <dev:remarks> <maml:para>Creates a settings resource with tier "db-n1-standard-1", and a maintenance window on monday at 22:00.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Instance Settings] </maml:linkText> <maml:uri>(https://cloud.google.com/sql/docs/instance-settings)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GcSqlSslCert --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcSqlSslCert</command:name> <command:verb>Add</command:verb> <command:noun>GcSqlSslCert</command:noun> <maml:description> <maml:para>Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate is not usable until the instance is restarted for first-generation instances.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an SSL certificate inside the given instance and returns it along with the private key and server certificate authority. The new certificate is not usable until the instance is restarted for first-generation instances</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Add-GcSqlSslCert</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CommonName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>Distinct name for the certificate being added to the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Add-GcSqlSslCert</maml:name> <!-- Parameter: CommonName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>Distinct name for the certificate being added to the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance we want to add an SSL Certificate to.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CommonName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>Distinct name for the certificate being added to the instance.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>The Instance we want to add an SSL Certificate to.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Instance we want to add an SSL Certificate to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SslCertDetail --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCertDetail</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcSqlSslCert "myInstance" "myCert"</dev:code> <dev:remarks> <maml:para>Adds the SSL Certificate called "myCert" to the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $myInstance | Add-GcSqlSslCert "myCert"</dev:code> <dev:remarks> <maml:para>Adds the SSL Certificate called "myCert" to the instance stored in $myInstance.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-GcSqlSslCert --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlSslCert</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlSslCert</command:noun> <maml:description> <maml:para>Retrieves a particular SSL certificate, or lists the current SSL certificates for an instance. Does not include the private key- for the private key must be saved from the response to initial creation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the specified SSL certificate, or lists the current SSL certificates for that instance. This is determined by if an Sha1Fingerprint is specified or not. Does not include the private key.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Single --> <command:syntaxItem> <maml:name>Get-GcSqlSslCert</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sha1Fingerprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Sha1Fingerprint</maml:name> <maml:description> <maml:para>Sha1 FingerPrint for the SSL Certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: List --> <command:syntaxItem> <maml:name>Get-GcSqlSslCert</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: List from Instance --> <command:syntaxItem> <maml:name>Get-GcSqlSslCert</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>An instance resource that you want to get the SSL certificates from.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sha1Fingerprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Sha1Fingerprint</maml:name> <maml:description> <maml:para>Sha1 FingerPrint for the SSL Certificate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>An instance resource that you want to get the SSL certificates from.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An instance resource that you want to get the SSL certificates from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SslCert --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCert</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlSslCert "myInstance"</dev:code> <dev:remarks> <maml:para>Gets a list of SSL Certificates for the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlSslCert $myInstance</dev:code> <dev:remarks> <maml:para>Gets a list of SSL Certificates for the instance stored in $myInstance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlSslCert "myInstance" "myFinger"</dev:code> <dev:remarks> <maml:para>Get a resource for the SSL Certificate identified by the Sha1Fingerprint "myFinger" for the instance "myInstance".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-GcSqlSslCert --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GcSqlSslCert</command:name> <command:verb>Remove</command:verb> <command:noun>GcSqlSslCert</command:noun> <maml:description> <maml:para>Deletes the SSL certificate. The change will not take effect until the instance is restarted for first-generation instances.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the SSL certificate for the instance.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GcSqlSslCert</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sha1Fingerprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Sha1Fingerprint</maml:name> <maml:description> <maml:para>Sha1 FingerPrint for the SSL Certificate you want to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GcSqlSslCert</maml:name> <!-- Parameter: Cert --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Cert</maml:name> <maml:description> <maml:para>The SSL Certificate that describes the SSL Certificate to remove.</maml:para> </maml:description> <command:parameterValue required="true">SslCert</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCert</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sha1Fingerprint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Sha1Fingerprint</maml:name> <maml:description> <maml:para>Sha1 FingerPrint for the SSL Certificate you want to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cert --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Cert</maml:name> <maml:description> <maml:para>The SSL Certificate that describes the SSL Certificate to remove.</maml:para> </maml:description> <command:parameterValue required="true">SslCert</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCert</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCert</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The SSL Certificate that describes the SSL Certificate to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GcSqlSslCert "myInstance" "myFinger"</dev:code> <dev:remarks> <maml:para>Removes the SSL Certificate identified with the sha1Fingerprint "myFinger" from the instance "myInstance".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Removes the SSL Certificate stored in "myInstance".</maml:para> </maml:introduction> <dev:code>PS C:\> Remove-GcSqlSslCert "myInstance"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Reset-GcSqlSslConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-GcSqlSslConfig</command:name> <command:verb>Reset</command:verb> <command:noun>GcSqlSslConfig</command:noun> <maml:description> <maml:para>Deletes all client certificates and generates a new server SSL certificate for the instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes all client certificates and generates a new server SSL certificate for the instance. The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Reset-GcSqlSslConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByInstance --> <command:syntaxItem> <maml:name>Reset-GcSqlSslConfig</maml:name> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>An instance resourve that you want to reset the SSL Configuration for.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>InstanceObject</maml:name> <maml:description> <maml:para>An instance resourve that you want to reset the SSL Configuration for.</maml:para> </maml:description> <command:parameterValue required="true">DatabaseInstance</command:parameterValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An instance resourve that you want to reset the SSL Configuration for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: DatabaseInstance --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Reset-GcSqlSslConfig "myInstance"</dev:code> <dev:remarks> <maml:para>Resets the SSL Certificates for the "myInstance" instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Reset-GcSqlSslConfig $instance</dev:code> <dev:remarks> <maml:para>Resets the SSL Certificates for the instance represented by the resource stored in $instance.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GcSqlSslEphemeral --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GcSqlSslEphemeral</command:name> <command:verb>Add</command:verb> <command:noun>GcSqlSslEphemeral</command:noun> <maml:description> <maml:para>Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-GcSqlSslEphemeral</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PublicKey --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>PublicKey</maml:name> <maml:description> <maml:para>PEM encoded public key to include in the signed certificate. Should be RSA or EC. Line endings should be LF.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Instance --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Instance</maml:name> <maml:description> <maml:para>Cloud SQL instance name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PublicKey --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>PublicKey</maml:name> <maml:description> <maml:para>PEM encoded public key to include in the signed certificate. Should be RSA or EC. Line endings should be LF.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>PEM encoded public key to include in the signed certificate. Should be RSA or EC. Line endings should be LF.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SslCert --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.SslCert</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GcSqlSslEphemeral "myInstance" "-----BEGIN PUBLIC KEY-----..."</dev:code> <dev:remarks> <maml:para>Adds an ephemeral SSL Certificate to the instance "myInstance"</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-GcSqlTiers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GcSqlTiers</command:name> <command:verb>Get</command:verb> <command:noun>GcSqlTiers</command:noun> <maml:description> <maml:para>Lists all available service tiers for Google Cloud SQL, for example D1, D2.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all available service tiers for Google Cloud SQL, for example D1, D2. Pricing information is available at https://cloud.google.com/sql/pricing.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-GcSqlTiers</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the project. Defaults to the Cloud SDK configuration for properties if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Tier --> <command:returnValue> <dev:type> <maml:name>Google.Apis.SQLAdmin.v1beta4.Data.Tier</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GcSqlTiers</dev:code> <dev:remarks> <maml:para>Gets a list of tiers available for the project set in gcloud config.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-GkeCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GkeCluster</command:name> <command:verb>Add</command:verb> <command:noun>GkeCluster</command:noun> <maml:description> <maml:para>Creates a Google Container Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a Google Container Cluster. If -Project and/or -Zone are not used, the cmdlet will use the default project and/or default zone. There are 3 ways to create a cluster. You can pass in a NodeConfig object (created using New-GkeNodeConfig) and the cmdlet will create a cluster whose node pools will have their configurations set from the NodeConfig object. Instead of passing in a NodeConfig object, you can also use the parameters provided in this cmdlet and a NodeConfig object will be automatically created and used in the cluster creation (same as above). In both cases above, you can specify how many node pools the cluster will have with -NumberOfNodePools. Lastly, you can also create a cluster by passing in an array of NodePool objects and a cluster with node pools similar to that array will be created.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByNodeConfigValues --> <command:syntaxItem> <maml:name>Add-GkeCluster</maml:name> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in the cluster, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in the cluster. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in the cluster. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in the cluster will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster. Name has to start with a letter, end with a number or letter and consists only of letters, numbers and hyphens.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MasterCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterCredential</maml:name> <maml:description> <maml:para>The credential to access the master endpoint.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableLoggingService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableLoggingService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Logging Service to write logs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableMonitoringService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableMonitoringService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Monitoring service to write metrics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHttpLoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHttpLoadBalancing</maml:name> <maml:description> <maml:para>Removes HTTP load balancing controller addon.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>Removes horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableKubernetesAlpha --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableKubernetesAlpha</maml:name> <maml:description> <maml:para>Enables Kubernetes alpha features on the cluster. This includes alpha API groups and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are AUTOMATICALLY DELETED thirty days after creation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the cluster will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the Google Compute Engine subnetwork to which the cluster is connected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterIpv4AddressRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterIpv4AddressRange</maml:name> <maml:description> <maml:para>The IP address range of the container pods in this cluster, in CIDR notation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The zones (in addition to the zone specified by -Zone parameter) in which the cluster's nodes should be located.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this cluster. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfNodePools --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfNodePools</maml:name> <maml:description> <maml:para>The number of node pools that the cluster will have. All the node pools will have the same config.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodeConfig --> <command:syntaxItem> <maml:name>Add-GkeCluster</maml:name> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in the cluster, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in the cluster. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in the cluster. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in the cluster will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster. Name has to start with a letter, end with a number or letter and consists only of letters, numbers and hyphens.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MasterCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterCredential</maml:name> <maml:description> <maml:para>The credential to access the master endpoint.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableLoggingService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableLoggingService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Logging Service to write logs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableMonitoringService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableMonitoringService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Monitoring service to write metrics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHttpLoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHttpLoadBalancing</maml:name> <maml:description> <maml:para>Removes HTTP load balancing controller addon.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>Removes horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableKubernetesAlpha --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableKubernetesAlpha</maml:name> <maml:description> <maml:para>Enables Kubernetes alpha features on the cluster. This includes alpha API groups and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are AUTOMATICALLY DELETED thirty days after creation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the cluster will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the Google Compute Engine subnetwork to which the cluster is connected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterIpv4AddressRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterIpv4AddressRange</maml:name> <maml:description> <maml:para>The IP address range of the container pods in this cluster, in CIDR notation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The zones (in addition to the zone specified by -Zone parameter) in which the cluster's nodes should be located.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this cluster. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfNodePools --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfNodePools</maml:name> <maml:description> <maml:para>The number of node pools that the cluster will have. All the node pools will have the same config.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodePool --> <command:syntaxItem> <maml:name>Add-GkeCluster</maml:name> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in the cluster, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in the cluster. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in the cluster. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in the cluster will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster. Name has to start with a letter, end with a number or letter and consists only of letters, numbers and hyphens.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MasterCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterCredential</maml:name> <maml:description> <maml:para>The credential to access the master endpoint.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableLoggingService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableLoggingService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Logging Service to write logs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableMonitoringService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableMonitoringService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Monitoring service to write metrics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHttpLoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHttpLoadBalancing</maml:name> <maml:description> <maml:para>Removes HTTP load balancing controller addon.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>Removes horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableKubernetesAlpha --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableKubernetesAlpha</maml:name> <maml:description> <maml:para>Enables Kubernetes alpha features on the cluster. This includes alpha API groups and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are AUTOMATICALLY DELETED thirty days after creation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the cluster will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the Google Compute Engine subnetwork to which the cluster is connected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterIpv4AddressRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterIpv4AddressRange</maml:name> <maml:description> <maml:para>The IP address range of the container pods in this cluster, in CIDR notation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The zones (in addition to the zone specified by -Zone parameter) in which the cluster's nodes should be located.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this cluster. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePool --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NodePool</maml:name> <maml:description> <maml:para>The node pools associated with this cluster.</maml:para> </maml:description> <command:parameterValue required="true">NodePool[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in the cluster, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> <maml:para>This is an alias of the InstanceMetadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in the cluster. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in the cluster. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in the cluster will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster. Name has to start with a letter, end with a number or letter and consists only of letters, numbers and hyphens.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MasterCredential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterCredential</maml:name> <maml:description> <maml:para>The credential to access the master endpoint.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisableLoggingService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableLoggingService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Logging Service to write logs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableMonitoringService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableMonitoringService</maml:name> <maml:description> <maml:para>Stop the cluster from using Google Cloud Monitoring service to write metrics.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHttpLoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHttpLoadBalancing</maml:name> <maml:description> <maml:para>Removes HTTP load balancing controller addon.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableHorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableHorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>Removes horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableKubernetesAlpha --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableKubernetesAlpha</maml:name> <maml:description> <maml:para>Enables Kubernetes alpha features on the cluster. This includes alpha API groups and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are AUTOMATICALLY DELETED thirty days after creation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the cluster will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the cluster will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Network --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Network</maml:name> <maml:description> <maml:para>Name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnetwork --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnetwork</maml:name> <maml:description> <maml:para>The name of the Google Compute Engine subnetwork to which the cluster is connected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterIpv4AddressRange --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterIpv4AddressRange</maml:name> <maml:description> <maml:para>The IP address range of the container pods in this cluster, in CIDR notation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The zones (in addition to the zone specified by -Zone parameter) in which the cluster's nodes should be located.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this cluster. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfNodePools --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfNodePools</maml:name> <maml:description> <maml:para>The number of node pools that the cluster will have. All the node pools will have the same config.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePool --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NodePool</maml:name> <maml:description> <maml:para>The node pools associated with this cluster.</maml:para> </maml:description> <command:parameterValue required="true">NodePool[]</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this cluster. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The node pools associated with this cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Add-GkeCluster -NodeConfig $nodeConfig ` -ClusterName "my-cluster" ` -Network "my-network"</dev:code> <dev:remarks> <maml:para>Creates a cluster named "my-cluster" in the default zone of the default project using config $nodeConfig and network "my-network".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GkeCluster -MachineType "n1-standard-4" ` -ClusterName "my-cluster" ` -Description "My new cluster" ` -Subnetwork "my-subnetwork" ` -EnableAutoUpgrade ` -MaximumNodesToScaleTo 2</dev:code> <dev:remarks> <maml:para>Creates a cluster named "my-cluster" with description "my new cluster" in the default zone of the default project using machine type "n1-standard-4" for each Google Compute Engine VMs in the cluster. The cluster will use the subnetwork "my-subnetwork". The cluster's nodes will have autoupgrade enabled. The cluster will also autoscale its node pool to a maximum of 2 nodes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GkeCluster -ImageType "GCI" ` -ClusterName "my-cluster" ` -Zone "us-central1-a" ` -MasterCredential (Get-Credential) ` -DisableMonitoringService ` -AdditionalZone "us-central1-f" ` -NumberOfNodePools 2 ` -DisableHttpLoadBalancing</dev:code> <dev:remarks> <maml:para>Creates a cluster named "my-cluster" in zone "us-central1-a" of the default project. Asides from "us-central1-a", the cluster's nodes will also be found at zone "us-central1-f". The cluster will not have Google Monitoring Service enabled to write metrics. The master node of the cluster will have credential supplied by (Get-Credential). Each node of the cluster will be of type GCI. The cluster will not have HTTP load balancing. The cluster created will have 2 node pools with the same node config.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> $nodePools = Get-GkeNodePool -Cluster "my-cluster" PS C:\> Add-GkeCluster -ClusterName "my-cluster-2" ` -NodePool $nodePools ` -DisableHorizontalPodAutoscaling</dev:code> <dev:remarks> <maml:para>Creates cluster "my-cluster-2" using the node pools from "my-cluster". The cluster will have horizontal pod autoscaling disabled.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Configs] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/reference/rest/v1/NodeConfig)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Kubernetes Labels] </maml:linkText> <maml:uri>(https://kubernetes.io/docs/user-guide/labels/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Preemptible VM instances] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/instances/preemptible)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GkeCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GkeCluster</command:name> <command:verb>Get</command:verb> <command:noun>GkeCluster</command:noun> <maml:description> <maml:para>Gets Google Container Clusters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Google Container Clusters. If -Project parameter is not specified, the default project will be used. If neither -Zone nor -ClusterName is used, the cmdlet will return every cluster in every zone in the project. If -Zone is used without -ClusterName, the cmdlet will return every cluster in the specified zone. If -ClusterName is used without -Zone, the cmdlet will return the specified clusters in the default zone (set in Cloud SDK Config). If -Clustername is used with -Zone, the cmdlet will return the specified clusters in the specified zone.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByZone --> <command:syntaxItem> <maml:name>Get-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the container clusters belong to. This parameter defaults to the zone in the Cloud SDK config if -ClusterName parameter is used. Otherwise, it defaults to all the zones.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the container clusters belong to. This parameter defaults to the zone in the Cloud SDK config if -ClusterName parameter is used. Otherwise, it defaults to all the zones.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The names of the clusters to search for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the container clusters belong to. This parameter defaults to the zone in the Cloud SDK config if -ClusterName parameter is used. Otherwise, it defaults to all the zones.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The names of the clusters to search for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The names of the clusters to search for.</maml:para> <maml:para>This is an alias of the ClusterName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GkeCluster</dev:code> <dev:remarks> <maml:para>Lists all container clusters in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GkeCluster -Zone "us-central1-a" -Project "my-project"</dev:code> <dev:remarks> <maml:para>Lists all container clusters in zone us-central1-a for the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GkeCluster -ClusterName "my-cluster"</dev:code> <dev:remarks> <maml:para>Gets the cluster "my-cluster" in the default zone of the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-GkeCluster -ClusterName "my-cluster", "my-cluster-2" -Zone "us-central1-a"</dev:code> <dev:remarks> <maml:para>Gets the clusters "my-cluster", "my-cluster-2" in the zone "us-central1-a" of the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Container Clusters] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/clusters/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GkeCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GkeCluster</command:name> <command:verb>Remove</command:verb> <command:noun>GkeCluster</command:noun> <maml:description> <maml:para>Removes a Google Container Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Container Cluster. You can either pass in a cluster object (from Get-GkeCluster cmdlet) or use -Cluster, -Project and -Zone parameters (if -Project and/or -Zone parameters are not used, the cmdlet will use the default project and/or default zone).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the container cluster to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-GkeCluster</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster object to be removed.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the container clusters belong to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the container cluster to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the container cluster to be removed.</maml:para> <maml:para>This is an alias of the ClusterName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The cluster object to be removed.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The cluster object to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GkeCluster -ClusterName "my-cluster" ` -Zone "us-west1-b"</dev:code> <dev:remarks> <maml:para>Removes the cluster "my-cluster" in the zone "us-west1-b" of the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $cluster = Get-GkeCluster -ClusterName "my-cluster" PS C:\> Remove-GkeCluster -InputObject $cluster</dev:code> <dev:remarks> <maml:para>Removes the cluster "my-cluster" by using the cluster object returned from Get-GkeCluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GkeCluster -Zone "us-west1-b" | Remove-GkeCluster</dev:code> <dev:remarks> <maml:para>Removes all clusters in zone "us-west1-b" of the default project by pipelining.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Container Clusters] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/clusters/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-GkeCluster --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-GkeCluster</command:name> <command:verb>Set</command:verb> <command:noun>GkeCluster</command:noun> <maml:description> <maml:para>Updates a Google Container Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a Google Container Cluster. Only one property can be updated at a time. The properties are: 1. AddonsConfig for a cluster (-LoadBalancing and -HorizontalPodAutoscaling). 2. Additional zones for the cluster (-AdditionalZone). 3. Version of the master, which can only be changed to the latest (-UpdateMaster). 4. Monitoring service for a cluster (-MonitoringService). 5. Autoscaling for a node pool in the cluster (-Min/MaximumNodesToScaleTo). 6. Kubernetes version for nodes in a node pool in the cluster (-NodeVersion). 7. Image type for nodes in a node pool in the cluster (-ImageType).</maml:para> <maml:para>To specify a cluster, you can supply its name to -ClusterName. If -Project and/or -Zone are not used in this case, the cmdlet will use the default project and/or default zone. The cmdlet also accepts a Cluster object (from Get-GkeCluster cmdlet) with -ClusterObject. In this case, the Project and Zone will come from the cluster object itself.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: UpdateNodePoolClusterName --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of node pool in the cluster to be updated. This parameter is mandatory if you want to update NodeVersion, Autoscaling or ImageType of a cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the maximum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the minimum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateAdditionalZoneClusterName --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateMasterClusterName --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateMaster --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMaster</maml:name> <maml:description> <maml:para>If set, the cluster's master will be updated to the latest Kubernetes version.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddonConfigsClusterName --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancing</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HTTP load balancing in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HorizontalPodAutoscaling in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateMonitoringServiceClusterName --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MonitoringService --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoringService</maml:name> <maml:description> <maml:para>This parameter is used to set the monitoring service of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateNodePoolClusterObject --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of node pool in the cluster to be updated. This parameter is mandatory if you want to update NodeVersion, Autoscaling or ImageType of a cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the maximum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the minimum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateAdditionalZoneClusterObject --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateMasterClusterObject --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateMaster --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMaster</maml:name> <maml:description> <maml:para>If set, the cluster's master will be updated to the latest Kubernetes version.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddonConfigsClusterObject --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancing</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HTTP load balancing in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HorizontalPodAutoscaling in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: UpdateMonitoringServiceClusterObject --> <command:syntaxItem> <maml:name>Set-GkeCluster</maml:name> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MonitoringService --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoringService</maml:name> <maml:description> <maml:para>This parameter is used to set the monitoring service of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of node pool in the cluster to be updated. This parameter is mandatory if you want to update NodeVersion, Autoscaling or ImageType of a cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster to be updated.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalZone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalZone</maml:name> <maml:description> <maml:para>The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateMaster --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateMaster</maml:name> <maml:description> <maml:para>If set, the cluster's master will be updated to the latest Kubernetes version.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LoadBalancing --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancing</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HTTP load balancing in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HorizontalPodAutoscaling --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HorizontalPodAutoscaling</maml:name> <maml:description> <maml:para>This parameter is used to enable or disable HorizontalPodAutoscaling in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MonitoringService --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitoringService</maml:name> <maml:description> <maml:para>This parameter is used to set the monitoring service of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the maximum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, a node pool in the cluster will have autoscaling enabled and this number will represent the minimum number of nodes that the node pool can scale to. If the cluster has more than 1 node pool, -NodePoolName is needed to determine which node pool the autoscaling will be applied to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-GkeCluster -ClusterName "my-cluster" ` -LoadBalancing $true</dev:code> <dev:remarks> <maml:para>Turns on load balancing for cluster "my-cluster" in the default zone and project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-GkeCluster -ClusterName "my-cluster" ` -Zone "asia-east1-a" ` -AdditionalZone "asia-east1-b", "asia-east1-c"</dev:code> <dev:remarks> <maml:para>Sets additional zones of cluster "my-cluster" in zone "asia-east1-a" to zones "asia-east1-b" and "asia-east1-c". This means the clusters will have nodes created in these zones. The primary zone ("asia-east1-a" in this case) will be added to the AdditionalZone array by the cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-GkeCluster -ClusterObject $clusterObject ` -NodePoolName "default-pool" ` -MaximumNodesToScaleTo 3</dev:code> <dev:remarks> <maml:para>Sets the node pool "default-pool" in the Cluster object $clusterObject to have autoscaling with a max nodes count of 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Set-GkeCluster -ClusterName "my-cluster" ` -NodePoolName "default-pool" ` -NodeVersion "1.4.9"</dev:code> <dev:remarks> <maml:para>Sets the Kubernetes version of nodes in node pool "default-pool" in cluster "my-cluster" to 1.4.9. Note that the version of the nodes has to be less than that of the master. Otherwise, the cmdlet will throw an error.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Container Clusters] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/clusters/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GkeNodeConfig --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GkeNodeConfig</command:name> <command:verb>New</command:verb> <command:noun>GkeNodeConfig</command:noun> <maml:description> <maml:para>Creates a Google Container Engine Node Config.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a Google Container Engine Node Config. The node config is used to configure various properties of a node in a container cluster so you can use the object returned by the cmdlet in Add-GkeCluster to create a container cluster. If -Project is not used, the cmdlet will use the default project. If -Zone is not used, the cmdlet will use the default zone. -Project and -Zone parameters are only used to provide tab-completion for the possible list of image and machine types applicable to the nodes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GkeNodeConfig</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node. Tags are used to identify valid sources or targets for network firewalls.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by the node VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> <maml:para>This is an alias of the InstanceMetadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node. Tags are used to identify valid sources or targets for network firewalls.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by the node VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GkeNodeConfig -ImageType CONTAINER_VM</dev:code> <dev:remarks> <maml:para>Creates a node config with image type CONTAINER_VM for each node.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GkeNodeConfig -ImageType CONTAINER_VM -MachineType n1-standard-1</dev:code> <dev:remarks> <maml:para>Creates a node config with image type CONTAINER_VM for each node and machine type n1-standard-1 for each Google Compute Engine used to create the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GkeNodeConfig -DiskSizeGb 20 -SsdCount 2</dev:code> <dev:remarks> <maml:para>Creates a node config with 20 Gb disk size and 2 SSDs for each node.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> New-GkeNodeConfig -Metadata @{"key" = "value"} -Label @{"release" = "stable"}</dev:code> <dev:remarks> <maml:para>Creates a node config with metadata pair "key" = "value" and Kubernetes label "release" = "stable".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> $serviceAccount = New-GceServiceAccountConfig -BigTableAdmin Full ` -CloudLogging None ` -CloudMonitoring None ` -ServiceControl $false ` -ServiceManagement $false ` -Storage None PS C:\> New-GkeNodeConfig -ServiceAccount $serviceAccount</dev:code> <dev:remarks> <maml:para>Creates a node config that uses the default service account with scopes "bigtable.admin".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\> New-GkeNodeConfig -Preemptible</dev:code> <dev:remarks> <maml:para>Creates a node config where each node is created as preemptible VM instances.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Configs] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/reference/rest/v1/NodeConfig)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Kubernetes Labels] </maml:linkText> <maml:uri>(https://kubernetes.io/docs/user-guide/labels/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Preemptible VM instances] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/instances/preemptible)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-GkeNodePool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-GkeNodePool</command:name> <command:verb>Add</command:verb> <command:noun>GkeNodePool</command:noun> <maml:description> <maml:para>Adds a Google Container Engine Node Pool to a Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a Google Container Engine Node Pool to a Cluster. If -Project is not used, the cmdlet will use the default project. If -Zone is not used, the cmdlet will use the default zone. -Project and -Zone parameters are only used to provide tab-completion for the possible list of image and machine types applicable to the nodes. You can either create a NodePool object separately with New-GkeNodePool and use it with -NodePool parameter or simply use the available parameters on this cmdlet to create a new NodePool. Instead of using -ClusterName to provide the name of the cluster, you can also use -ClusterObject, which takes in a Cluster object from Get-GkeCluster. When you use -ClusterObject, the Project and Zone will automatically be taken from the Cluster object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByNodeConfigClusterName --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool to be added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodeConfigValuesClusterName --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool to be added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodePoolClusterName --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePool --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>NodePool</maml:name> <maml:description> <maml:para>The node pool to be added to the cluster.</maml:para> </maml:description> <command:parameterValue required="true">NodePool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodePoolClusterObject --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePool --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>NodePool</maml:name> <maml:description> <maml:para>The node pool to be added to the cluster.</maml:para> </maml:description> <command:parameterValue required="true">NodePool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The cluster object that the node pool will be added to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodeConfigClusterObject --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool to be added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The cluster object that the node pool will be added to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodeConfigValuesClusterObject --> <command:syntaxItem> <maml:name>Add-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool to be added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The cluster object that the node pool will be added to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePool --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>NodePool</maml:name> <maml:description> <maml:para>The node pool to be added to the cluster.</maml:para> </maml:description> <command:parameterValue required="true">NodePool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool to be added.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The cluster object that the node pool will be added to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> <maml:para>This is an alias of the InstanceMetadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The node pool to be added to the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $nodePool = New-GkeNodePool -NodePoolName "my-nodepool" -ImageType CONTAINER_VM PS C:\> Add-GkeNodePool -NodePool $nodePool -Cluster "my-cluster"</dev:code> <dev:remarks> <maml:para>Creates a node pool "my-nodepool" with image type CONTAINER_VM for each node. Adds that pool to cluster "my-cluter".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Add-GkeNodePool -NodePoolName "my-nodepool" ` -ImageType CONTAINER_VM ` -MachineType n1-standard-1 ` -InitialNodeCount 3 ` -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Creates a node pool with image type CONTAINER_VM for each node and machine type n1-standard-1 for each Google Compute Engine used to create the node pool. The node pool will be added to cluster $cluster where $cluster is a Cluster object returned from Get-GkeCluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Add-GkeNodePool "my-nodepool" -DiskSizeGb 20 ` -SsdCount 2 ` -EnableAutoUpgrade ` -Cluster "my-cluster" ` -Zone "europe-west1-c"</dev:code> <dev:remarks> <maml:para>Creates a node pool with 20 Gb disk size and 2 SSDs for each node. Each node in the node pool will have autoupgrade enabled. The node pool will be added to cluster "my-cluster" in zone "europe-west1-c".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Configs] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/reference/rest/v1/NodeConfig)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Kubernetes Labels] </maml:linkText> <maml:uri>(https://kubernetes.io/docs/user-guide/labels/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Preemptible VM instances] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/instances/preemptible)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-GkeNodePool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-GkeNodePool</command:name> <command:verb>Get</command:verb> <command:noun>GkeNodePool</command:noun> <maml:description> <maml:para>Gets Google Container Engine Node Pools from a Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets Google Container Engine Node Pools from a Cluster. If -Project and/or -Zone parameter is not specified, the default project and/or the default zone will be used. If -NodePoolName parameter is not used, the cmdlet will return every node pools in the cluster. You can either supply cluster name with -ClusterName or a Cluster object from Get-GkeCluster with -ClusterObject. If a Cluster object is used, the cmdlet will use the Project and Zone from the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByClusterName --> <command:syntaxItem> <maml:name>Get-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name(s) of the node pool(s) that will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByClusterObject --> <command:syntaxItem> <maml:name>Get-GkeNodePool</maml:name> <!-- Parameter: NodePoolName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name(s) of the node pool(s) that will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone in which the node pool's cluster is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name(s) of the node pool(s) that will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the cluster that the node pool belongs to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-GkeNodePool -ClusterName "my-cluster"</dev:code> <dev:remarks> <maml:para>Lists all node pools in cluster "my-cluster" in the default project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-GkeNodePool -Zone "us-central1-a" -Project "my-project" -ClusterName "my-cluster"</dev:code> <dev:remarks> <maml:para>Lists all node pools in cluster "my-cluster" in zone us-central1-a of the project "my-project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-GkeNodePool -ClusterName "my-cluster" -NodePoolName "default-1", "default-2"</dev:code> <dev:remarks> <maml:para>Gets node pools "default-1" and "default-2" in cluster "my-cluster" in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-GkeNodePool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-GkeNodePool</command:name> <command:verb>New</command:verb> <command:noun>GkeNodePool</command:noun> <maml:description> <maml:para>Creates a Google Container Engine Node Pool</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a Google Container Engine Node Pool. The node pool can be used to create a cluster with Add-GkeCluster or added to an existing cluster with Add-GkeNodePool. If -Project is not used, the cmdlet will use the default project. If -Zone is not used, the cmdlet will use the default zone. -Project and -Zone parameters are only used to provide tab-completion for the possible list of image and machine types applicable to the nodes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByNodeConfig --> <command:syntaxItem> <maml:name>New-GkeNodePool</maml:name> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodeConfigValues --> <command:syntaxItem> <maml:name>New-GkeNodePool</maml:name> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>Name of the node pool.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodeConfig --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodeConfig</maml:name> <maml:description> <maml:para>Passed in a NodeConfig object containing configuration for the nodes in this node pool. This object can be created with New-GkeNodeConfig cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">NodeConfig</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodeConfig</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DiskSizeGb --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeGb</maml:name> <maml:description> <maml:para>Size of the disk attached to each node in this node pool, specified in GB. The smallest allowed disk size is 10GB. The default disk size is 100GB.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstanceMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>InstanceMetadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Metadata"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Metadata key/value pairs assigned to instances in this node pool. Keys must conform to the regexp [a-zA-Z0-9-_]+ and not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script" and "user-data".</maml:para> <maml:para>This is an alias of the InstanceMetadata parameter.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The map of Kubernetes labels (key/value pairs) to be applied to each node in this node pool. This is in addition to any default label(s) that Kubernetes may apply to the node.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSsdCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalSsdCount</maml:name> <maml:description> <maml:para>The number of local SSD disks attached to each node in this node pool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>The list of instance tags applied to each node in this node pool. Tags are used to identify valid sources or targets for network firewalls. Each tag must complied with RFC1035.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceAccount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>The Google Cloud Platform Service Account to be used by each node's VMs. Use New-GceServiceAccountConfig to create the service account and appropriate scopes.</maml:para> </maml:description> <command:parameterValue required="true">ServiceAccount</command:parameterValue> <dev:type> <maml:name>Google.Apis.Compute.v1.Data.ServiceAccount</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Preemptible --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Preemptible</maml:name> <maml:description> <maml:para>If set, every node created in this node pool will be a preemptible VM instance.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnableAutoUpgrade --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableAutoUpgrade</maml:name> <maml:description> <maml:para>If set, nodes in the node pool will be automatically upgraded.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaximumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaximumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the minimum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MininumNodesToScaleTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MininumNodesToScaleTo</maml:name> <maml:description> <maml:para>If set, the node pool will have autoscaling enabled and this number will represent the maximum number of nodes in the node pool that the cluster can scale to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InitialNodeCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InitialNodeCount</maml:name> <maml:description> <maml:para>The number of nodes to create in a nodepool.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node config belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool -NodePoolName "my-nodepool" -ImageType CONTAINER_VM</dev:code> <dev:remarks> <maml:para>Creates a node pool "my-nodepool" with image type CONTAINER_VM for each node.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool -NodePoolName "my-nodepool" ` -ImageType CONTAINER_VM ` -MachineType n1-standard-1 ` -InitialNodeCount 3</dev:code> <dev:remarks> <maml:para>Creates a node pool with image type CONTAINER_VM for each node and machine type n1-standard-1 for each Google Compute Engine used to create the cluster. The node pool will have an initial node count of 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool "my-nodepool" -DiskSizeGb 20 -SsdCount 2 -EnableAutoUpgrade</dev:code> <dev:remarks> <maml:para>Creates a node pool with 20 Gb disk size and 2 SSDs for each node. Each node in the node pool will have autoupgrade enabled.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool "my-nodepool" -Metadata @{"key" = "value"} ` -Label @{"release" = "stable"} ` -MaximumNodesToScaleTo 3</dev:code> <dev:remarks> <maml:para>Creates a node pool with metadata pair "key" = "value" and Kubernetes label "release" = "stable". The node pool will scale to 3 nodes maximum.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> $serviceAccount = New-GceServiceAccountConfig -BigTableAdmin Full ` -CloudLogging None ` -CloudMonitoring None ` -ServiceControl $false ` -ServiceManagement $false ` -Storage None PS C:\> New-GkeNodePool "my-nodepool" -ServiceAccount $serviceAccount</dev:code> <dev:remarks> <maml:para>Creates a node pool that uses the default service account with scopes "bigtable.admin".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool "my-nodepool" -Preemptible</dev:code> <dev:remarks> <maml:para>Creates a node pool where each node is created as preemptible VM instances.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>PS C:\> New-GkeNodePool "my-nodepool" -NodeConfig $nodeConfig</dev:code> <dev:remarks> <maml:para>Creates a node pool using NodeConfig $nodeconfig.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Configs] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/reference/rest/v1/NodeConfig)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Kubernetes Labels] </maml:linkText> <maml:uri>(https://kubernetes.io/docs/user-guide/labels/)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Preemptible VM instances] </maml:linkText> <maml:uri>(https://cloud.google.com/compute/docs/instances/preemptible)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-GkeNodePool --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-GkeNodePool</command:name> <command:verb>Remove</command:verb> <command:noun>GkeNodePool</command:noun> <maml:description> <maml:para>Removes a Google Container NodePool from a Cluster.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a Google Container NodePool from a Cluster. If -Project and -Zone are not specified, the cmdlets will default to the default project and zone. If -ClusterObject is used instead of -ClusterName, the Project and Zone will come from the cluster object. If a node pool object is given to -ClusterName, the cmdlet will get Project, Zone and Cluster information from the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByClusterName --> <command:syntaxItem> <maml:name>Remove-GkeNodePool</maml:name> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node pool's cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of the node pool to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the container cluster that the node pool is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByClusterObject --> <command:syntaxItem> <maml:name>Remove-GkeNodePool</maml:name> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of the node pool to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The container cluster object that the node pool is in.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByNodePoolObject --> <command:syntaxItem> <maml:name>Remove-GkeNodePool</maml:name> <!-- Parameter: NodePoolObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodePoolObject</maml:name> <maml:description> <maml:para>The NodePool object to be removed. Cluster, Zone and Project will be inferred from the object.</maml:para> </maml:description> <command:parameterValue required="true">NodePool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project that the node pool's cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Zone --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Zone</maml:name> <maml:description> <maml:para>The zone that the node pool's cluster belongs to. This parameter defaults to the project in the Cloud SDK config.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NodePoolName</maml:name> <maml:description> <maml:para>The name of the node pool to be removed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NodePoolObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NodePoolObject</maml:name> <maml:description> <maml:para>The NodePool object to be removed. Cluster, Zone and Project will be inferred from the object.</maml:para> </maml:description> <command:parameterValue required="true">NodePool</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.NodePool</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>The name of the container cluster that the node pool is in.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClusterObject --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClusterObject</maml:name> <maml:description> <maml:para>The container cluster object that the node pool is in.</maml:para> </maml:description> <command:parameterValue required="true">Cluster</command:parameterValue> <dev:type> <maml:name>Google.Apis.Container.v1.Data.Cluster</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Remove-GkeCluster -ClusterName "my-cluster" ` -Zone "us-west1-b" ` -NodePoolName "my-nodepool"</dev:code> <dev:remarks> <maml:para>Removes the node pool "my-nodepool" in cluster "my-cluster" in the zone "us-west1-b" of the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> [Node Pools] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/node-pools)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> [Container Clusters] </maml:linkText> <maml:uri>(https://cloud.google.com/container-engine/docs/clusters/)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |