Edit

Share via

Remove-AzApiManagementIdentityProvider

  • Reference
Module:
Az.ApiManagement

Removes an existing Identity Provider Configuration.

Syntax

Remove-AzApiManagementIdentityProvider
      -Context <PsApiManagementContext>
      -Type <PsApiManagementIdentityProviderType>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Removes an existing Identity Provider Configuration.

Examples

Example 1: Removes the Facebook identity provider settings from ApiManagement service

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru

Deletes configuration related to Facebook Identity provider configuration.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Context

Instance of PsApiManagementContext. This parameter is required.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise.

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

-Type

Identifier of an existing Identity Provider. This parameter is required.

Type:PsApiManagementIdentityProviderType
Accepted values:Facebook, Google, Microsoft, Twitter, Aad, AadB2C
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

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

Inputs

PsApiManagementContext

PsApiManagementIdentityProviderType

SwitchParameter

Outputs

Boolean