Manages an Azure AD/Entra ID connector in Dex using the Microsoft-specific connector (type: microsoft). This connector provides Microsoft-specific features like group filtering and domain restrictions.
Create AzureMicrosoftConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AzureMicrosoftConnector(name: string, args: AzureMicrosoftConnectorArgs, opts?: CustomResourceOptions);@overload
def AzureMicrosoftConnector(resource_name: str,
args: AzureMicrosoftConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AzureMicrosoftConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
connector_id: Optional[str] = None,
name: Optional[str] = None,
redirect_uri: Optional[str] = None,
tenant: Optional[str] = None,
groups: Optional[str] = None)func NewAzureMicrosoftConnector(ctx *Context, name string, args AzureMicrosoftConnectorArgs, opts ...ResourceOption) (*AzureMicrosoftConnector, error)public AzureMicrosoftConnector(string name, AzureMicrosoftConnectorArgs args, CustomResourceOptions? opts = null)
public AzureMicrosoftConnector(String name, AzureMicrosoftConnectorArgs args)
public AzureMicrosoftConnector(String name, AzureMicrosoftConnectorArgs args, CustomResourceOptions options)
type: dex:resources:AzureMicrosoftConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AzureMicrosoftConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AzureMicrosoftConnectorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AzureMicrosoftConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AzureMicrosoftConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AzureMicrosoftConnectorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azureMicrosoftConnectorResource = new Dex.Resources.AzureMicrosoftConnector("azureMicrosoftConnectorResource", new()
{
ClientId = "string",
ClientSecret = "string",
ConnectorId = "string",
Name = "string",
RedirectUri = "string",
Tenant = "string",
Groups = "string",
});
example, err := resources.NewAzureMicrosoftConnector(ctx, "azureMicrosoftConnectorResource", &resources.AzureMicrosoftConnectorArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ConnectorId: pulumi.String("string"),
Name: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
Tenant: pulumi.String("string"),
Groups: pulumi.String("string"),
})
var azureMicrosoftConnectorResource = new AzureMicrosoftConnector("azureMicrosoftConnectorResource", AzureMicrosoftConnectorArgs.builder()
.clientId("string")
.clientSecret("string")
.connectorId("string")
.name("string")
.redirectUri("string")
.tenant("string")
.groups("string")
.build());
azure_microsoft_connector_resource = dex.resources.AzureMicrosoftConnector("azureMicrosoftConnectorResource",
client_id="string",
client_secret="string",
connector_id="string",
name="string",
redirect_uri="string",
tenant="string",
groups="string")
const azureMicrosoftConnectorResource = new dex.resources.AzureMicrosoftConnector("azureMicrosoftConnectorResource", {
clientId: "string",
clientSecret: "string",
connectorId: "string",
name: "string",
redirectUri: "string",
tenant: "string",
groups: "string",
});
type: dex:resources:AzureMicrosoftConnector
properties:
clientId: string
clientSecret: string
connectorId: string
groups: string
name: string
redirectUri: string
tenant: string
AzureMicrosoftConnector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AzureMicrosoftConnector resource accepts the following input properties:
- Client
Id string - Azure AD application (client) ID.
- Client
Secret string - Azure AD application client secret.
- Connector
Id string - Unique identifier for the Azure Microsoft connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- Tenant string
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- Groups string
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
- Client
Id string - Azure AD application (client) ID.
- Client
Secret string - Azure AD application client secret.
- Connector
Id string - Unique identifier for the Azure Microsoft connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- Tenant string
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- Groups string
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
- client
Id String - Azure AD application (client) ID.
- client
Secret String - Azure AD application client secret.
- connector
Id String - Unique identifier for the Azure Microsoft connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- tenant String
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- groups String
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
- client
Id string - Azure AD application (client) ID.
- client
Secret string - Azure AD application client secret.
- connector
Id string - Unique identifier for the Azure Microsoft connector.
- name string
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- tenant string
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- groups string
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
- client_
id str - Azure AD application (client) ID.
- client_
secret str - Azure AD application client secret.
- connector_
id str - Unique identifier for the Azure Microsoft connector.
- name str
- Human-readable name for the connector, displayed to users during login.
- redirect_
uri str - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- tenant str
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- groups str
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
- client
Id String - Azure AD application (client) ID.
- client
Secret String - Azure AD application client secret.
- connector
Id String - Unique identifier for the Azure Microsoft connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Azure AD. Must match Dex's callback URL.
- tenant String
- Azure AD tenant identifier. Can be 'common' (any Azure AD account), 'organizations' (any organizational account), or a specific tenant ID (UUID format).
- groups String
- Name of the claim that contains group memberships (e.g., 'groups'). Used for group-based access control.
Outputs
All input properties are implicitly available as output properties. Additionally, the AzureMicrosoftConnector resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- dex kotaicode/pulumi-dex
- License
