Edit

Share via

Remove-CsTeamTemplate

  • Reference
Module:
MicrosoftTeamsPowerShell

This cmdlet deletes a specified Team Template from Microsoft Teams.

Syntax

Remove-CsTeamTemplate
      -OdataId <String>
      [-Break]
      [-HttpPipelineAppend <SendAsyncStep[]>]
      [-HttpPipelinePrepend <SendAsyncStep[]>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-CsTeamTemplate
      -InputObject <IConfigApiBasedCmdletsIdentity>
      [-Break]
      [-HttpPipelineAppend <SendAsyncStep[]>]
      [-HttpPipelinePrepend <SendAsyncStep[]>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Examples

EXAMPLE 1

PS C:> Remove-CsTeamTemplate -OdataId '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'

Removes template with OData Id '/api/teamtemplates/v1.0/b24f8ba6-0949-452e-ad4b-a353f38ed8af/Tenant/en-US'.

EXAMPLE 2

PS C:> (Get-CsTeamTemplateList -PublicTemplateLocale en-US) | where Name -like 'test' | ForEach-Object {Remove-CsTeamTemplate -OdataId $_.OdataId}

Removes template that meets the following specifications: 1) Locale set to en-US. 2) Name contains 'test'.

Parameters

-Break

Wait for .NET debugger to attach

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Type:SendAsyncStep[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Type:SendAsyncStep[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OdataId

A composite URI of a template.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Proxy

The URI for the proxy server to use

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IConfigApiBasedCmdletsIdentity

Outputs

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IAny

Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.IErrorObject

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IConfigApiBasedCmdletsIdentity>: Identity Parameter

  • [Bssid <String>]:
  • [ChassisId <String>]:
  • [CivicAddressId <String>]: Civic address id.
  • [Country <String>]:
  • [GroupId <String>]: The ID of a group whose policy assignments will be returned.
  • [Id <String>]:
  • [Identity <String>]:
  • [Locale <String>]:
  • [LocationId <String>]: Location id.
  • [OdataId <String>]: A composite URI of a template.
  • [OperationId <String>]: The ID of a batch policy assignment operation.
  • [OrderId <String>]:
  • [PackageName <String>]: The name of a specific policy package
  • [PolicyType <String>]: The policy type for which group policy assignments will be returned.
  • [Port <String>]:
  • [PortInOrderId <String>]:
  • [PublicTemplateLocale <String>]: Language and country code for localization of publicly available templates.
  • [SubnetId <String>]:
  • [TenantId <String>]:
  • [UserId <String>]: UserId. Supports Guid. Eventually UPN and SIP.