< Back
Remove-AzureRmApiManagementIdentityProvider
Post
NAME Remove-AzureRmApiManagementIdentityProvider
SYNOPSIS
Removes an existing Identity Provider Configuration.
SYNTAX
Remove-AzureRmApiManagementIdentityProvider -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru] -Type
{Facebook | Google | Microsoft | Twitter | Aad} [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Removes an existing Identity Provider Configuration.
PARAMETERS
-Context <PsApiManagementContext>
Instance of PsApiManagementContext. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <PsApiManagementIdentityProviderType>
Identifier of an existing Identity Provider. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
bool
NOTES
Removes the Facebook identity provider settings from ApiManagement service
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru
Deletes configuration related to Facebook Identity provider configuration.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... typrovider
New-AzureRmApiManagementIdentityProvider
Get-AzureRmApiManagementIdentityProvider
Set-AzureRmApiManagementIdentityProvider
SYNOPSIS
Removes an existing Identity Provider Configuration.
SYNTAX
Remove-AzureRmApiManagementIdentityProvider -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru] -Type
{Facebook | Google | Microsoft | Twitter | Aad} [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Removes an existing Identity Provider Configuration.
PARAMETERS
-Context <PsApiManagementContext>
Instance of PsApiManagementContext. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <PsApiManagementIdentityProviderType>
Identifier of an existing Identity Provider. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
bool
NOTES
Removes the Facebook identity provider settings from ApiManagement service
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Remove-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru
Deletes configuration related to Facebook Identity provider configuration.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... typrovider
New-AzureRmApiManagementIdentityProvider
Get-AzureRmApiManagementIdentityProvider
Set-AzureRmApiManagementIdentityProvider