1. Packages
  2. Azure Native
  3. API Docs
  4. Provider
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.Provider

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

The provider type for the native Azure package.

Create Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             auxiliary_tenant_ids: Optional[Sequence[str]] = None,
             client_certificate_password: Optional[str] = None,
             client_certificate_path: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             disable_pulumi_partner_id: Optional[bool] = None,
             environment: Optional[str] = None,
             location: Optional[str] = None,
             metadata_host: Optional[str] = None,
             msi_endpoint: Optional[str] = None,
             oidc_request_token: Optional[str] = None,
             oidc_request_url: Optional[str] = None,
             oidc_token: Optional[str] = None,
             partner_id: Optional[str] = None,
             subscription_id: Optional[str] = None,
             tenant_id: Optional[str] = None,
             use_msi: Optional[bool] = None,
             use_oidc: Optional[bool] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:azure-native
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Provider resource accepts the following input properties:

AuxiliaryTenantIds List<string>
Any additional Tenant IDs which should be used for authentication.
ClientCertificatePassword string
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
ClientSecret string
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
DisablePulumiPartnerId bool
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
Location string
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
MetadataHost string
The Hostname of the Azure Metadata Service.
MsiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
OidcRequestToken string
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
OidcRequestUrl string
The URL to initiate the oidcRequestToken OIDC token exchange.
OidcToken string
The OIDC token to exchange for an Azure token.
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SubscriptionId string
The Subscription ID which should be used.
TenantId string
The Tenant ID which should be used.
UseMsi bool
Allow Managed Service Identity to be used for Authentication.
UseOidc bool
Allow OpenID Connect (OIDC) to be used for Authentication.
AuxiliaryTenantIds []string
Any additional Tenant IDs which should be used for authentication.
ClientCertificatePassword string
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
ClientSecret string
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
DisablePulumiPartnerId bool
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
Location string
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
MetadataHost string
The Hostname of the Azure Metadata Service.
MsiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
OidcRequestToken string
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
OidcRequestUrl string
The URL to initiate the oidcRequestToken OIDC token exchange.
OidcToken string
The OIDC token to exchange for an Azure token.
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SubscriptionId string
The Subscription ID which should be used.
TenantId string
The Tenant ID which should be used.
UseMsi bool
Allow Managed Service Identity to be used for Authentication.
UseOidc bool
Allow OpenID Connect (OIDC) to be used for Authentication.
auxiliaryTenantIds List<String>
Any additional Tenant IDs which should be used for authentication.
clientCertificatePassword String
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
clientSecret String
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disablePulumiPartnerId Boolean
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
environment String
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
location String
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
metadataHost String
The Hostname of the Azure Metadata Service.
msiEndpoint String
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
oidcRequestToken String
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
oidcRequestUrl String
The URL to initiate the oidcRequestToken OIDC token exchange.
oidcToken String
The OIDC token to exchange for an Azure token.
partnerId String
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
subscriptionId String
The Subscription ID which should be used.
tenantId String
The Tenant ID which should be used.
useMsi Boolean
Allow Managed Service Identity to be used for Authentication.
useOidc Boolean
Allow OpenID Connect (OIDC) to be used for Authentication.
auxiliaryTenantIds string[]
Any additional Tenant IDs which should be used for authentication.
clientCertificatePassword string
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
clientSecret string
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disablePulumiPartnerId boolean
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
environment string
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
location string
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
metadataHost string
The Hostname of the Azure Metadata Service.
msiEndpoint string
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
oidcRequestToken string
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
oidcRequestUrl string
The URL to initiate the oidcRequestToken OIDC token exchange.
oidcToken string
The OIDC token to exchange for an Azure token.
partnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
subscriptionId string
The Subscription ID which should be used.
tenantId string
The Tenant ID which should be used.
useMsi boolean
Allow Managed Service Identity to be used for Authentication.
useOidc boolean
Allow OpenID Connect (OIDC) to be used for Authentication.
auxiliary_tenant_ids Sequence[str]
Any additional Tenant IDs which should be used for authentication.
client_certificate_password str
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
client_secret str
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disable_pulumi_partner_id bool
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
environment str
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
location str
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
metadata_host str
The Hostname of the Azure Metadata Service.
msi_endpoint str
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
oidc_request_token str
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
oidc_request_url str
The URL to initiate the oidcRequestToken OIDC token exchange.
oidc_token str
The OIDC token to exchange for an Azure token.
partner_id str
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
subscription_id str
The Subscription ID which should be used.
tenant_id str
The Tenant ID which should be used.
use_msi bool
Allow Managed Service Identity to be used for Authentication.
use_oidc bool
Allow OpenID Connect (OIDC) to be used for Authentication.
auxiliaryTenantIds List<String>
Any additional Tenant IDs which should be used for authentication.
clientCertificatePassword String
The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
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.
clientSecret String
The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
disablePulumiPartnerId Boolean
This will disable the Pulumi Partner ID which is used if a custom partnerId isn't specified.
environment String
The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public.
location String
The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource.
metadataHost String
The Hostname of the Azure Metadata Service.
msiEndpoint String
The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
oidcRequestToken String
Your cloud service or provider’s bearer token to exchange for an OIDC ID token.
oidcRequestUrl String
The URL to initiate the oidcRequestToken OIDC token exchange.
oidcToken String
The OIDC token to exchange for an Azure token.
partnerId String
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
subscriptionId String
The Subscription ID which should be used.
tenantId String
The Tenant ID which should be used.
useMsi Boolean
Allow Managed Service Identity to be used for Authentication.
useOidc Boolean
Allow OpenID Connect (OIDC) to be used for Authentication.

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 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
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.2.0 published on Monday, Apr 14, 2025 by Pulumi