Top / Microsoft Azure / Azure API Management / Identity Provider Microsoft

Azure API Management Identity Provider Microsoft

This page shows how to write Terraform and Azure Resource Manager for API Management Identity Provider Microsoft and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_api_management_identity_provider_microsoft (Terraform)

The Identity Provider Microsoft in API Management can be configured in Terraform with the resource name azurerm_api_management_identity_provider_microsoft. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L7
resource "azurerm_api_management_identity_provider_microsoft" "this" {
  api_management_name = var.api_management_name
  client_id           = var.client_id
  client_secret       = var.client_secret
  resource_group_name = var.resource_group_name

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Manages an API Management Microsoft Identity Provider.

>> from Terraform Registry

Microsoft.ApiManagement/service/identityProviders (Azure Resource Manager)

The service/identityProviders in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/identityProviders. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    Identity Provider Type identifier.

  • properties required
      • allowedTenants optional - array

        List of Allowed Tenants when configuring Azure Active Directory login.

      • authority optional - string

        OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

      • clientId required - 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.

      • clientSecret required - 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 optional - string

        Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

      • profileEditingPolicyName optional - string

        Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

      • signinPolicyName optional - string

        Signin Policy Name. Only applies to AAD B2C Identity Provider.

      • signinTenant optional - string

        The TenantId to use instead of Common when logging into Active Directory

      • signupPolicyName optional - string

        Signup Policy Name. Only applies to AAD B2C Identity Provider.

      • type optional - string

        Identity Provider Type identifier.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management Identity Provider Microsoft?

Azure API Management Identity Provider Microsoft is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure API Management Identity Provider Microsoft?

For Terraform, the kevinhead/azurerm source code example is useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents