Provider

The provider type for the azuread package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create a Provider Resource

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             client_certificate_password: Optional[str] = None,
             client_certificate_path: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             disable_terraform_partner_id: Optional[bool] = None,
             environment: Optional[str] = None,
             metadata_host: Optional[str] = None,
             msi_endpoint: Optional[str] = None,
             partner_id: Optional[str] = None,
             tenant_id: Optional[str] = None,
             use_msi: Optional[bool] = None)
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ProviderArgs
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 ProviderArgs
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 ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

MetadataHost string
The Hostname which should be used for the Azure Metadata Service.
ClientCertificatePassword string
ClientCertificatePath string
The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
ClientId string
The Client ID which should be used for service principal authentication.
ClientSecret string
The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
DisableTerraformPartnerId bool
Disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.
Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public. It can also be sourced from the following environment variable: ARM_ENVIRONMENT
MsiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. It can also be sourced from the following environment variable: ARM_MSI_ENDPOINT
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
TenantId string
The Tenant ID which should be used. Works with all authentication methods except MSI.
UseMsi bool
Allow Managed Service Identity to be used for Authentication. It can also be sourced from the following environment variable: ARM_USE_MSI
MetadataHost string
The Hostname which should be used for the Azure Metadata Service.
ClientCertificatePassword string
ClientCertificatePath string
The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
ClientId string
The Client ID which should be used for service principal authentication.
ClientSecret string
The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
DisableTerraformPartnerId bool
Disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.
Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public. It can also be sourced from the following environment variable: ARM_ENVIRONMENT
MsiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. It can also be sourced from the following environment variable: ARM_MSI_ENDPOINT
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
TenantId string
The Tenant ID which should be used. Works with all authentication methods except MSI.
UseMsi bool
Allow Managed Service Identity to be used for Authentication. It can also be sourced from the following environment variable: ARM_USE_MSI
metadataHost string
The Hostname which should be used for the Azure Metadata Service.
clientCertificatePassword string
clientCertificatePath string
The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
clientId string
The Client ID which should be used for service principal authentication.
clientSecret string
The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
disableTerraformPartnerId boolean
Disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.
environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public. It can also be sourced from the following environment variable: ARM_ENVIRONMENT
msiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. It can also be sourced from the following environment variable: ARM_MSI_ENDPOINT
partnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
tenantId string
The Tenant ID which should be used. Works with all authentication methods except MSI.
useMsi boolean
Allow Managed Service Identity to be used for Authentication. It can also be sourced from the following environment variable: ARM_USE_MSI
metadata_host str
The Hostname which should be used for the Azure Metadata Service.
client_certificate_password str
client_certificate_path str
The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
client_id str
The Client ID which should be used for service principal authentication.
client_secret str
The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
disable_terraform_partner_id bool
Disable the Terraform Partner ID which is used if a custom partner_id isn’t specified.
environment str
The Cloud Environment which should be used. Possible values are public, usgovernment, german, and china. Defaults to public. It can also be sourced from the following environment variable: ARM_ENVIRONMENT
msi_endpoint str
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically. It can also be sourced from the following environment variable: ARM_MSI_ENDPOINT
partner_id str
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
tenant_id str
The Tenant ID which should be used. Works with all authentication methods except MSI.
use_msi bool
Allow Managed Service Identity to be used for Authentication. It can also be sourced from the following environment variable: ARM_USE_MSI

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider 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 str
The provider-assigned unique ID for this managed resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azuread
License
Apache-2.0
Notes
This Pulumi package is based on the azuread Terraform Provider.