< Back

New-AzureRmApiManagementIdentityProvider

Tue Jan 29, 2019 9:29 pm

NAME New-AzureRmApiManagementIdentityProvider



SYNOPSIS

Creates a new Identity Provider configuration.





SYNTAX

New-AzureRmApiManagementIdentityProvider [-AllowedTenants <String[]>] -ClientId <String> -ClientSecret <String> -Context <PsApiManagementContext>

[-DefaultProfile <IAzureContextContainer>] -Type {Facebook | Google | Microsoft | Twitter | Aad} [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Creates a new Identity Provider configuration.





PARAMETERS

-AllowedTenants <String[]>

List of allowed Azure Active Directory Tenants



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClientId <String>

Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for

Microsoft.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClientSecret <String>

Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook

login, API Key for Google login, Public Key for Microsoft.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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



-Type <PsApiManagementIdentityProviderType>

Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional.



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

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider







NOTES









Example 1: Configures Facebook as an identity Provider for Developer Portal Logins



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>New-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -ClientId 'sdfsfwerwerw' -ClientSecret

'sdgsdfgfst43tewfewrf'



This command configures Facebook Identity as a accepted Identity Provider on the Developer Portal of the ApiManagement service. This takes as

input the ClientId and ClientSecret of the Facebook app.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... typrovider

Get-AzureRmApiManagementIdentityProvider

Remove-AzureRmApiManagementIdentityProvider

Set-AzureRmApiManagementIdentityProvider