# AzAPI Resource Provider
The AzAPI Resource Provider lets you manage [AzAPI](https://learn.microsoft.com/en-us/azure/developer/terraform/overview-azapi-provider) resources.
## Installing
This package is available for several languages/platforms:
### Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
```bash
npm install @ediri/azapi
```
or `yarn`:
```bash
yarn add @ediri/azapi
```
### Python
To use from Python, install using `pip`:
```bash
pip install ediri_azapi
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/dirien/pulumi-azapi/sdk
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
dotnet add package ediri.Azapi
```
## Configuration
The following configuration points are supported for the `AzAPI` provider:
* `ClientId` - (Optional) The Client ID which should be used. This can also be sourced from the `ARM_CLIENT_ID` Environment Variable.
* `Environment` - (Optional) The Cloud Environment which should be used. Possible values are `public`, `usgovernment` and `china`. Defaults to `public`. This can also be sourced from the `ARM_ENVIRONMENT` Environment Variable.
* `SubscriptionId` - (Optional) The Subscription ID which should be used. This can also be sourced from the `ARM_SUBSCRIPTION_ID` Environment Variable.
* `TenantId` - (Optional) The Tenant ID should be used. This can also be sourced from the `ARM_TENANT_ID` Environment Variable.
---
It's possible to configure the behaviour of certain resources using the following properties:
* `DefaultTags` - (Optional) A mapping of tags which should be assigned to the azure resource as default tags. `tags` in each resource block can override the `default_tags`.
* `DefaultLocation` - (Optional) The default Azure Region where the azure resource should exist. `location` in each resource block can override the `default_location`. Changing this forces new resources to be created.
---
When authenticating as a Service Principal using a Client Certificate, the following fields can be set:
* `ClientCertificatePassword` - (Optional) The password associated with the Client Certificate. This can also be sourced from the `ARM_CLIENT_CERTIFICATE_PASSWORD` Environment Variable.
* `ClientCertificatePath` - (Optional) The path to the Client Certificate associated with the Service Principal which should be used. This can also be sourced from the `ARM_CLIENT_CERTIFICATE_PATH` Environment Variable.
---
When authenticating as a Service Principal using a Client Secret, the following fields can be set:
* `ClientSecret` - (Optional) The Client Secret which should be used. This can also be sourced from the `ARM_CLIENT_SECRET` Environment Variable.
---
When authenticating as a Service Principal using Open ID Connect, the following fields can be set:
* `OidcRequestToken` - (Optional) The bearer token for the request to the OIDC provider. This can also be sourced from the `ARM_OIDC_REQUEST_TOKEN` or `ACTIONS_ID_TOKEN_REQUEST_TOKEN` Environment Variables.
* `OidcRequestUrl` - (Optional) The URL for the OIDC provider from which to request an ID token. This can also be sourced from the `ARM_OIDC_REQUEST_URL` or `ACTIONS_ID_TOKEN_REQUEST_URL` Environment Variables.
* `OidcToken` - (Optional) The ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the `ARM_OIDC_TOKEN` environment Variable.
* `OidcTokenFilePath` - (Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the `ARM_OIDC_TOKEN_FILE_PATH` environment Variable.
* `UseOidc` - (Optional) Should OIDC be used for Authentication? This can also be sourced from the `ARM_USE_OIDC` Environment Variable. Defaults to `false`.
---
For some advanced scenarios, such as where more granular permissions are necessary - the following properties can be set:
* `DisableCorrelationRequestId` - (Optional) Disable sending the `x-ms-correlation-request-id` header. This can also be sourced from the `ARM_DISABLE_CORRELATION_REQUEST_ID` environment variable. Defaults to `false`.
* `DisableTerraformPartnerId` - (Optional) Disable sending the Terraform Partner ID if a custom `partner_id` isn't specified, which allows Microsoft to better understand the usage of Terraform. The Partner ID does not give HashiCorp any direct access to usage information. This can also be sourced from the `ARM_DISABLE_TERRAFORM_PARTNER_ID` environment variable. Defaults to `false`.
* `PartnerId` - (Optional) A GUID/UUID that is [registered](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution#register-guids-and-offers) with Microsoft to facilitate partner resource usage attribution. This can also be sourced from the `ARM_PARTNER_ID` Environment Variable.
* `SkipProviderRegistration` - (Optional) Should the Provider skip registering the Resource Providers it supports? This can also be sourced from the `ARM_SKIP_PROVIDER_REGISTRATION` Environment Variable. Defaults to `false`.
## Reference
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/azapi/api-docs/).
Raw data
{
"_id": null,
"home_page": "https://github.com/dirien/pulumi-azapi",
"name": "ediri-azapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi azapi category/cloud",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/39/ff/0c3ca49f1ddfa9c57b4f5e4d983db4bf93ccf0e37d3c1b6ba95417a61553/ediri_azapi-1.12.2.tar.gz",
"platform": null,
"description": "# AzAPI Resource Provider\n\n\n\nThe AzAPI Resource Provider lets you manage [AzAPI](https://learn.microsoft.com/en-us/azure/developer/terraform/overview-azapi-provider) resources.\n\n## Installing\n\nThis package is available for several languages/platforms:\n\n### Node.js (JavaScript/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n```bash\nnpm install @ediri/azapi\n```\n\nor `yarn`:\n\n```bash\nyarn add @ediri/azapi\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install ediri_azapi\n```\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library:\n\n```bash\ngo get github.com/dirien/pulumi-azapi/sdk\n```\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n```bash\ndotnet add package ediri.Azapi\n```\n\n## Configuration\n\nThe following configuration points are supported for the `AzAPI` provider:\n\n* `ClientId` - (Optional) The Client ID which should be used. This can also be sourced from the `ARM_CLIENT_ID` Environment Variable.\n\n* `Environment` - (Optional) The Cloud Environment which should be used. Possible values are `public`, `usgovernment` and `china`. Defaults to `public`. This can also be sourced from the `ARM_ENVIRONMENT` Environment Variable.\n\n* `SubscriptionId` - (Optional) The Subscription ID which should be used. This can also be sourced from the `ARM_SUBSCRIPTION_ID` Environment Variable.\n\n* `TenantId` - (Optional) The Tenant ID should be used. This can also be sourced from the `ARM_TENANT_ID` Environment Variable.\n\n---\n\nIt's possible to configure the behaviour of certain resources using the following properties:\n\n* `DefaultTags` - (Optional) A mapping of tags which should be assigned to the azure resource as default tags. `tags` in each resource block can override the `default_tags`.\n\n* `DefaultLocation` - (Optional) The default Azure Region where the azure resource should exist. `location` in each resource block can override the `default_location`. Changing this forces new resources to be created.\n\n---\n\nWhen authenticating as a Service Principal using a Client Certificate, the following fields can be set:\n\n* `ClientCertificatePassword` - (Optional) The password associated with the Client Certificate. This can also be sourced from the `ARM_CLIENT_CERTIFICATE_PASSWORD` Environment Variable.\n\n* `ClientCertificatePath` - (Optional) The path to the Client Certificate associated with the Service Principal which should be used. This can also be sourced from the `ARM_CLIENT_CERTIFICATE_PATH` Environment Variable.\n\n---\n\nWhen authenticating as a Service Principal using a Client Secret, the following fields can be set:\n\n* `ClientSecret` - (Optional) The Client Secret which should be used. This can also be sourced from the `ARM_CLIENT_SECRET` Environment Variable.\n\n---\n\nWhen authenticating as a Service Principal using Open ID Connect, the following fields can be set:\n\n* `OidcRequestToken` - (Optional) The bearer token for the request to the OIDC provider. This can also be sourced from the `ARM_OIDC_REQUEST_TOKEN` or `ACTIONS_ID_TOKEN_REQUEST_TOKEN` Environment Variables.\n\n* `OidcRequestUrl` - (Optional) The URL for the OIDC provider from which to request an ID token. This can also be sourced from the `ARM_OIDC_REQUEST_URL` or `ACTIONS_ID_TOKEN_REQUEST_URL` Environment Variables.\n\n* `OidcToken` - (Optional) The ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the `ARM_OIDC_TOKEN` environment Variable.\n\n* `OidcTokenFilePath` - (Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC). This can also be sourced from the `ARM_OIDC_TOKEN_FILE_PATH` environment Variable.\n\n* `UseOidc` - (Optional) Should OIDC be used for Authentication? This can also be sourced from the `ARM_USE_OIDC` Environment Variable. Defaults to `false`.\n\n---\n\nFor some advanced scenarios, such as where more granular permissions are necessary - the following properties can be set:\n\n* `DisableCorrelationRequestId` - (Optional) Disable sending the `x-ms-correlation-request-id` header. This can also be sourced from the `ARM_DISABLE_CORRELATION_REQUEST_ID` environment variable. Defaults to `false`.\n\n* `DisableTerraformPartnerId` - (Optional) Disable sending the Terraform Partner ID if a custom `partner_id` isn't specified, which allows Microsoft to better understand the usage of Terraform. The Partner ID does not give HashiCorp any direct access to usage information. This can also be sourced from the `ARM_DISABLE_TERRAFORM_PARTNER_ID` environment variable. Defaults to `false`.\n\n* `PartnerId` - (Optional) A GUID/UUID that is [registered](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution#register-guids-and-offers) with Microsoft to facilitate partner resource usage attribution. This can also be sourced from the `ARM_PARTNER_ID` Environment Variable.\n\n* `SkipProviderRegistration` - (Optional) Should the Provider skip registering the Resource Providers it supports? This can also be sourced from the `ARM_SKIP_PROVIDER_REGISTRATION` Environment Variable. Defaults to `false`.\n\n## Reference\n\nFor detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/azapi/api-docs/).\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Azapi resources",
"version": "1.12.2",
"project_urls": {
"Homepage": "https://github.com/dirien/pulumi-azapi",
"Repository": "https://github.com/dirien/pulumi-azapi"
},
"split_keywords": [
"pulumi",
"azapi",
"category/cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39ff0c3ca49f1ddfa9c57b4f5e4d983db4bf93ccf0e37d3c1b6ba95417a61553",
"md5": "f354d405a733e6566ce9fee405fe5c5a",
"sha256": "d605a7009744d48f4e8f87c4c569ff35b5464dd3576d21c8f83f2c96071ad45c"
},
"downloads": -1,
"filename": "ediri_azapi-1.12.2.tar.gz",
"has_sig": false,
"md5_digest": "f354d405a733e6566ce9fee405fe5c5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32831,
"upload_time": "2024-05-11T13:03:19",
"upload_time_iso_8601": "2024-05-11T13:03:19.588064Z",
"url": "https://files.pythonhosted.org/packages/39/ff/0c3ca49f1ddfa9c57b4f5e4d983db4bf93ccf0e37d3c1b6ba95417a61553/ediri_azapi-1.12.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 13:03:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dirien",
"github_project": "pulumi-azapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ediri-azapi"
}
JSON
