Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AzAPI
  3. API Docs
  4. Provider
AzAPI v1.12.2 published on Saturday, May 11, 2024 by dirien
dirien/pulumi-azapi

azapi.Provider

Explore with Pulumi AI

AzAPI v1.12.2 published on Saturday, May 11, 2024 by dirien
dirien/pulumi-azapi

The provider type for the azapi 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 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: ProviderArgs,
             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,
             custom_correlation_request_id: Optional[str] = None,
             default_location: Optional[str] = None,
             default_name: Optional[str] = None,
             default_naming_prefix: Optional[str] = None,
             default_naming_suffix: Optional[str] = None,
             default_tags: Optional[Mapping[str, str]] = None,
             disable_correlation_request_id: Optional[bool] = None,
             disable_terraform_partner_id: Optional[bool] = None,
             endpoint: Optional[ProviderEndpointArgs] = None,
             environment: Optional[str] = None,
             oidc_request_token: Optional[str] = None,
             oidc_request_url: Optional[str] = None,
             oidc_token: Optional[str] = None,
             oidc_token_file_path: Optional[str] = None,
             partner_id: Optional[str] = None,
             skip_provider_registration: Optional[bool] = None,
             subscription_id: Optional[str] = None,
             tenant_id: Optional[str] = None,
             use_cli: Optional[bool] = 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, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:azapi
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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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:

Environment This property is required. string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
AuxiliaryTenantIds List<string>
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.
CustomCorrelationRequestId string
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
DefaultLocation string
DefaultName string
DefaultNamingPrefix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

DefaultNamingSuffix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

DefaultTags Dictionary<string, string>
DisableCorrelationRequestId bool
This will disable the x-ms-correlation-request-id header.
DisableTerraformPartnerId bool
Endpoint ediri.Azapi.Inputs.ProviderEndpoint
OidcRequestToken string
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
OidcRequestUrl string
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
OidcToken string
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
OidcTokenFilePath string
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipProviderRegistration bool
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
SubscriptionId string
The Subscription ID which should be used.
TenantId string
The Tenant ID which should be used.
UseCli bool
Allow Azure CLI to be used for Authentication.
UseMsi bool
Allow Managed Service Identity to be used for Authentication.
UseOidc bool
Allow OpenID Connect to be used for authentication
Environment This property is required. string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
AuxiliaryTenantIds []string
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.
CustomCorrelationRequestId string
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
DefaultLocation string
DefaultName string
DefaultNamingPrefix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

DefaultNamingSuffix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

DefaultTags map[string]string
DisableCorrelationRequestId bool
This will disable the x-ms-correlation-request-id header.
DisableTerraformPartnerId bool
Endpoint ProviderEndpointArgs
OidcRequestToken string
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
OidcRequestUrl string
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
OidcToken string
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
OidcTokenFilePath string
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
PartnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
SkipProviderRegistration bool
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
SubscriptionId string
The Subscription ID which should be used.
TenantId string
The Tenant ID which should be used.
UseCli bool
Allow Azure CLI to be used for Authentication.
UseMsi bool
Allow Managed Service Identity to be used for Authentication.
UseOidc bool
Allow OpenID Connect to be used for authentication
environment This property is required. String
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
auxiliaryTenantIds List<String>
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.
customCorrelationRequestId String
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
defaultLocation String
defaultName String
defaultNamingPrefix String

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultNamingSuffix String

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultTags Map<String,String>
disableCorrelationRequestId Boolean
This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId Boolean
endpoint ProviderEndpoint
oidcRequestToken String
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
oidcRequestUrl String
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
oidcToken String
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath String
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId String
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration Boolean
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscriptionId String
The Subscription ID which should be used.
tenantId String
The Tenant ID which should be used.
useCli Boolean
Allow Azure CLI to be used for Authentication.
useMsi Boolean
Allow Managed Service Identity to be used for Authentication.
useOidc Boolean
Allow OpenID Connect to be used for authentication
environment This property is required. string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
auxiliaryTenantIds string[]
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.
customCorrelationRequestId string
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
defaultLocation string
defaultName string
defaultNamingPrefix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultNamingSuffix string

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultTags {[key: string]: string}
disableCorrelationRequestId boolean
This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId boolean
endpoint ProviderEndpoint
oidcRequestToken string
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
oidcRequestUrl string
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
oidcToken string
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath string
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId string
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration boolean
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscriptionId string
The Subscription ID which should be used.
tenantId string
The Tenant ID which should be used.
useCli boolean
Allow Azure CLI to be used for Authentication.
useMsi boolean
Allow Managed Service Identity to be used for Authentication.
useOidc boolean
Allow OpenID Connect to be used for authentication
environment This property is required. str
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
auxiliary_tenant_ids Sequence[str]
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.
custom_correlation_request_id str
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
default_location str
default_name str
default_naming_prefix str

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

default_naming_suffix str

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

default_tags Mapping[str, str]
disable_correlation_request_id bool
This will disable the x-ms-correlation-request-id header.
disable_terraform_partner_id bool
endpoint ProviderEndpointArgs
oidc_request_token str
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
oidc_request_url str
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
oidc_token str
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidc_token_file_path str
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partner_id str
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skip_provider_registration bool
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscription_id str
The Subscription ID which should be used.
tenant_id str
The Tenant ID which should be used.
use_cli bool
Allow Azure CLI to be used for Authentication.
use_msi bool
Allow Managed Service Identity to be used for Authentication.
use_oidc bool
Allow OpenID Connect to be used for authentication
environment This property is required. String
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
auxiliaryTenantIds List<String>
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.
customCorrelationRequestId String
The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
defaultLocation String
defaultName String
defaultNamingPrefix String

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultNamingSuffix String

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's name field instead.

defaultTags Map<String>
disableCorrelationRequestId Boolean
This will disable the x-ms-correlation-request-id header.
disableTerraformPartnerId Boolean
endpoint Property Map
oidcRequestToken String
The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
oidcRequestUrl String
The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.
oidcToken String
The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
oidcTokenFilePath String
The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
partnerId String
A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
skipProviderRegistration Boolean
Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
subscriptionId String
The Subscription ID which should be used.
tenantId String
The Tenant ID which should be used.
useCli Boolean
Allow Azure CLI to be used for Authentication.
useMsi Boolean
Allow Managed Service Identity to be used for Authentication.
useOidc Boolean
Allow OpenID Connect 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.

Supporting Types

ProviderEndpoint
, ProviderEndpointArgs

ActiveDirectoryAuthorityHost string
The Active Directory login endpoint which should be used.
ResourceManagerAudience string
The resource ID to obtain AD tokens for.
ResourceManagerEndpoint string
The Resource Manager Endpoint which should be used.
ActiveDirectoryAuthorityHost string
The Active Directory login endpoint which should be used.
ResourceManagerAudience string
The resource ID to obtain AD tokens for.
ResourceManagerEndpoint string
The Resource Manager Endpoint which should be used.
activeDirectoryAuthorityHost String
The Active Directory login endpoint which should be used.
resourceManagerAudience String
The resource ID to obtain AD tokens for.
resourceManagerEndpoint String
The Resource Manager Endpoint which should be used.
activeDirectoryAuthorityHost string
The Active Directory login endpoint which should be used.
resourceManagerAudience string
The resource ID to obtain AD tokens for.
resourceManagerEndpoint string
The Resource Manager Endpoint which should be used.
active_directory_authority_host str
The Active Directory login endpoint which should be used.
resource_manager_audience str
The resource ID to obtain AD tokens for.
resource_manager_endpoint str
The Resource Manager Endpoint which should be used.
activeDirectoryAuthorityHost String
The Active Directory login endpoint which should be used.
resourceManagerAudience String
The resource ID to obtain AD tokens for.
resourceManagerEndpoint String
The Resource Manager Endpoint which should be used.

Package Details

Repository
azapi dirien/pulumi-azapi
License
Apache-2.0
Notes
This Pulumi package is based on the azapi Terraform Provider.
AzAPI v1.12.2 published on Saturday, May 11, 2024 by dirien
dirien/pulumi-azapi