IdentityProviderAad
Manages an API Management AAD Identity Provider.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PublisherName = "My Company",
PublisherEmail = "company@mycompany.io",
SkuName = "Developer_1",
});
var exampleIdentityProviderAad = new Azure.ApiManagement.IdentityProviderAad("exampleIdentityProviderAad", new Azure.ApiManagement.IdentityProviderAadArgs
{
ResourceGroupName = exampleResourceGroup.Name,
ApiManagementName = exampleService.Name,
ClientId = "00000000-0000-0000-0000-000000000000",
ClientSecret = "00000000000000000000000000000000",
AllowedTenants =
{
"00000000-0000-0000-0000-000000000000",
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
PublisherName: pulumi.String("My Company"),
PublisherEmail: pulumi.String("company@mycompany.io"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
_, err = apimanagement.NewIdentityProviderAad(ctx, "exampleIdentityProviderAad", &apimanagement.IdentityProviderAadArgs{
ResourceGroupName: exampleResourceGroup.Name,
ApiManagementName: exampleService.Name,
ClientId: pulumi.String("00000000-0000-0000-0000-000000000000"),
ClientSecret: pulumi.String("00000000000000000000000000000000"),
AllowedTenants: pulumi.StringArray{
pulumi.String("00000000-0000-0000-0000-000000000000"),
},
})
if err != nil {
return err
}
return nil
})
}import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
publisher_name="My Company",
publisher_email="company@mycompany.io",
sku_name="Developer_1")
example_identity_provider_aad = azure.apimanagement.IdentityProviderAad("exampleIdentityProviderAad",
resource_group_name=example_resource_group.name,
api_management_name=example_service.name,
client_id="00000000-0000-0000-0000-000000000000",
client_secret="00000000000000000000000000000000",
allowed_tenants=["00000000-0000-0000-0000-000000000000"])import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
publisherName: "My Company",
publisherEmail: "company@mycompany.io",
skuName: "Developer_1",
});
const exampleIdentityProviderAad = new azure.apimanagement.IdentityProviderAad("exampleIdentityProviderAad", {
resourceGroupName: exampleResourceGroup.name,
apiManagementName: exampleService.name,
clientId: "00000000-0000-0000-0000-000000000000",
clientSecret: "00000000000000000000000000000000",
allowedTenants: ["00000000-0000-0000-0000-000000000000"],
});Create a IdentityProviderAad Resource
new IdentityProviderAad(name: string, args: IdentityProviderAadArgs, opts?: CustomResourceOptions);def IdentityProviderAad(resource_name, opts=None, allowed_tenants=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None, __props__=None);func NewIdentityProviderAad(ctx *Context, name string, args IdentityProviderAadArgs, opts ...ResourceOption) (*IdentityProviderAad, error)public IdentityProviderAad(string name, IdentityProviderAadArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args IdentityProviderAadArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IdentityProviderAadArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IdentityProviderAadArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
IdentityProviderAad Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The IdentityProviderAad resource accepts the following input properties:
- Allowed
Tenants List<string> List of allowed AAD Tenants.
- Api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- Client
Id string Client Id of the Application in the AAD Identity Provider.
- Client
Secret string Client secret of the Application in the AAD Identity Provider.
- Resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- Allowed
Tenants []string List of allowed AAD Tenants.
- Api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- Client
Id string Client Id of the Application in the AAD Identity Provider.
- Client
Secret string Client secret of the Application in the AAD Identity Provider.
- Resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- allowed
Tenants string[] List of allowed AAD Tenants.
- api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- client
Id string Client Id of the Application in the AAD Identity Provider.
- client
Secret string Client secret of the Application in the AAD Identity Provider.
- resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- allowed_
tenants List[str] List of allowed AAD Tenants.
- api_
management_ strname The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- client_
id str Client Id of the Application in the AAD Identity Provider.
- client_
secret str Client secret of the Application in the AAD Identity Provider.
- resource_
group_ strname The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the IdentityProviderAad resource produces the following output properties:
Look up an Existing IdentityProviderAad Resource
Get an existing IdentityProviderAad resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IdentityProviderAadState, opts?: CustomResourceOptions): IdentityProviderAadstatic get(resource_name, id, opts=None, allowed_tenants=None, api_management_name=None, client_id=None, client_secret=None, resource_group_name=None, __props__=None);func GetIdentityProviderAad(ctx *Context, name string, id IDInput, state *IdentityProviderAadState, opts ...ResourceOption) (*IdentityProviderAad, error)public static IdentityProviderAad Get(string name, Input<string> id, IdentityProviderAadState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Allowed
Tenants List<string> List of allowed AAD Tenants.
- Api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- Client
Id string Client Id of the Application in the AAD Identity Provider.
- Client
Secret string Client secret of the Application in the AAD Identity Provider.
- Resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- Allowed
Tenants []string List of allowed AAD Tenants.
- Api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- Client
Id string Client Id of the Application in the AAD Identity Provider.
- Client
Secret string Client secret of the Application in the AAD Identity Provider.
- Resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- allowed
Tenants string[] List of allowed AAD Tenants.
- api
Management stringName The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- client
Id string Client Id of the Application in the AAD Identity Provider.
- client
Secret string Client secret of the Application in the AAD Identity Provider.
- resource
Group stringName The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
- allowed_
tenants List[str] List of allowed AAD Tenants.
- api_
management_ strname The Name of the API Management Service where this AAD Identity Provider should be created. Changing this forces a new resource to be created.
- client_
id str Client Id of the Application in the AAD Identity Provider.
- client_
secret str Client secret of the Application in the AAD Identity Provider.
- resource_
group_ strname The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.