azapi.Provider
Explore with Pulumi AI
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
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,
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,
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_oidc: 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)
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.
- 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.
- name String
- The unique name of the resource.
- args 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
The Provider resource accepts the following input properties:
- Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- Client
Certificate stringPassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- Client
Certificate stringPath 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 string The Client ID which should be used.
- Client
Secret string The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
- Default
Location string - Default
Name string - Default
Naming stringPrefix - Default
Naming stringSuffix - Dictionary<string, string>
- Disable
Correlation boolRequest Id This will disable the x-ms-correlation-request-id header.
- Disable
Terraform boolPartner Id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- Oidc
Request stringToken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- Oidc
Request stringUrl 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 string The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- Oidc
Token stringFile Path The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- Partner
Id string A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
- Skip
Provider boolRegistration Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
- Subscription
Id string The Subscription ID which should be used.
- Tenant
Id string The Tenant ID which should be used.
- Use
Oidc bool Allow OpenID Connect to be used for authentication
- Environment string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- Client
Certificate stringPassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- Client
Certificate stringPath 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 string The Client ID which should be used.
- Client
Secret string The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
- Default
Location string - Default
Name string - Default
Naming stringPrefix - Default
Naming stringSuffix - map[string]string
- Disable
Correlation boolRequest Id This will disable the x-ms-correlation-request-id header.
- Disable
Terraform boolPartner Id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- Oidc
Request stringToken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- Oidc
Request stringUrl 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 string The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- Oidc
Token stringFile Path The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- Partner
Id string A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
- Skip
Provider boolRegistration Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
- Subscription
Id string The Subscription ID which should be used.
- Tenant
Id string The Tenant ID which should be used.
- Use
Oidc bool Allow OpenID Connect to be used for authentication
- environment String
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- client
Certificate StringPassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- client
Certificate StringPath 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 String The Client ID which should be used.
- client
Secret String The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
- default
Location String - default
Name String - default
Naming StringPrefix - default
Naming StringSuffix - Map<String,String>
- disable
Correlation BooleanRequest Id This will disable the x-ms-correlation-request-id header.
- disable
Terraform BooleanPartner Id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- oidc
Request StringToken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- oidc
Request StringUrl 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 String The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- oidc
Token StringFile Path The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- partner
Id String A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
- skip
Provider BooleanRegistration Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
- subscription
Id String The Subscription ID which should be used.
- tenant
Id String The Tenant ID which should be used.
- use
Oidc Boolean Allow OpenID Connect to be used for authentication
- environment string
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- client
Certificate stringPassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- client
Certificate stringPath 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 string The Client ID which should be used.
- client
Secret string The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
- default
Location string - default
Name string - default
Naming stringPrefix - default
Naming stringSuffix - {[key: string]: string}
- disable
Correlation booleanRequest Id This will disable the x-ms-correlation-request-id header.
- disable
Terraform booleanPartner Id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- oidc
Request stringToken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- oidc
Request stringUrl 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 string The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- oidc
Token stringFile Path The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- partner
Id string A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
- skip
Provider booleanRegistration Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
- subscription
Id string The Subscription ID which should be used.
- tenant
Id string The Tenant ID which should be used.
- use
Oidc boolean Allow OpenID Connect to be used for authentication
- environment str
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- client_
certificate_ strpassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- client_
certificate_ strpath 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.
- default_
location str - default_
name str - default_
naming_ strprefix - default_
naming_ strsuffix - Mapping[str, str]
- disable_
correlation_ boolrequest_ id This will disable the x-ms-correlation-request-id header.
- disable_
terraform_ boolpartner_ id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- oidc_
request_ strtoken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- oidc_
request_ strurl 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_ strfile_ path 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_ boolregistration 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_
oidc bool Allow OpenID Connect to be used for authentication
- environment String
The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
- client
Certificate StringPassword The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate
- client
Certificate StringPath 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 String The Client ID which should be used.
- client
Secret String The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
- default
Location String - default
Name String - default
Naming StringPrefix - default
Naming StringSuffix - Map<String>
- disable
Correlation BooleanRequest Id This will disable the x-ms-correlation-request-id header.
- disable
Terraform BooleanPartner Id This will disable the Terraform Partner ID which is used if a custom
partner_id
isn't specified.- oidc
Request StringToken The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.
- oidc
Request StringUrl 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 String The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- oidc
Token StringFile Path The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
- partner
Id String A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
- skip
Provider BooleanRegistration Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
- subscription
Id String The Subscription ID which should be used.
- tenant
Id String The Tenant ID which should be used.
- use
Oidc 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.
Package Details
- Repository
- azapi dirien/pulumi-azapi
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azapi
Terraform Provider.