1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getIdentityProvider
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.apimanagement.getIdentityProvider

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets the configuration details of the identity Provider configured in specified service instance.

Uses Azure REST API version 2022-09-01-preview.

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Using getIdentityProvider

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIdentityProvider(args: GetIdentityProviderArgs, opts?: InvokeOptions): Promise<GetIdentityProviderResult>
function getIdentityProviderOutput(args: GetIdentityProviderOutputArgs, opts?: InvokeOptions): Output<GetIdentityProviderResult>
Copy
def get_identity_provider(identity_provider_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          service_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetIdentityProviderResult
def get_identity_provider_output(identity_provider_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          service_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetIdentityProviderResult]
Copy
func LookupIdentityProvider(ctx *Context, args *LookupIdentityProviderArgs, opts ...InvokeOption) (*LookupIdentityProviderResult, error)
func LookupIdentityProviderOutput(ctx *Context, args *LookupIdentityProviderOutputArgs, opts ...InvokeOption) LookupIdentityProviderResultOutput
Copy

> Note: This function is named LookupIdentityProvider in the Go SDK.

public static class GetIdentityProvider 
{
    public static Task<GetIdentityProviderResult> InvokeAsync(GetIdentityProviderArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityProviderResult> Invoke(GetIdentityProviderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIdentityProviderResult> getIdentityProvider(GetIdentityProviderArgs args, InvokeOptions options)
public static Output<GetIdentityProviderResult> getIdentityProvider(GetIdentityProviderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getIdentityProvider
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IdentityProviderName
This property is required.
Changes to this property will trigger replacement.
string
Identity Provider Type identifier.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
IdentityProviderName
This property is required.
Changes to this property will trigger replacement.
string
Identity Provider Type identifier.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
identityProviderName
This property is required.
Changes to this property will trigger replacement.
String
Identity Provider Type identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
identityProviderName
This property is required.
Changes to this property will trigger replacement.
string
Identity Provider Type identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
identity_provider_name
This property is required.
Changes to this property will trigger replacement.
str
Identity Provider Type identifier.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
identityProviderName
This property is required.
Changes to this property will trigger replacement.
String
Identity Provider Type identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getIdentityProvider Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AllowedTenants List<string>
List of Allowed Tenants when configuring Azure Active Directory login.
Authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
ClientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
PasswordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninTenant string
The TenantId to use instead of Common when logging into Active Directory
SignupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
AzureApiVersion string
The Azure API version of the resource.
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.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AllowedTenants []string
List of Allowed Tenants when configuring Azure Active Directory login.
Authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
ClientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
PasswordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninTenant string
The TenantId to use instead of Common when logging into Active Directory
SignupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
azureApiVersion String
The Azure API version of the resource.
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
allowedTenants List<String>
List of Allowed Tenants when configuring Azure Active Directory login.
authority String
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary String
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
passwordResetPolicyName String
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName String
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName String
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant String
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName String
Signup Policy Name. Only applies to AAD B2C Identity Provider.
azureApiVersion string
The Azure API version of the resource.
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.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
allowedTenants string[]
List of Allowed Tenants when configuring Azure Active Directory login.
authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
passwordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant string
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
azure_api_version str
The Azure API version of the resource.
client_id str
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.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
allowed_tenants Sequence[str]
List of Allowed Tenants when configuring Azure Active Directory login.
authority str
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
client_library str
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
client_secret str
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
password_reset_policy_name str
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name str
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name str
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signin_tenant str
The TenantId to use instead of Common when logging into Active Directory
signup_policy_name str
Signup Policy Name. Only applies to AAD B2C Identity Provider.
azureApiVersion String
The Azure API version of the resource.
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.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
allowedTenants List<String>
List of Allowed Tenants when configuring Azure Active Directory login.
authority String
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary String
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
passwordResetPolicyName String
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName String
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName String
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant String
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName String
Signup Policy Name. Only applies to AAD B2C Identity Provider.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi