Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@stephybun
stephybun committed Nov 28, 2024
1 parent 1e2ffb5 commit 399b9e4
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 59 deletions.
66 changes: 33 additions & 33 deletions website/docs/r/ai_services_hub.html.markdown → website/docs/r/ai_foundry.html.markdown
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
subcategory: "AI Services"
subcategory: "Machine Learning"
layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_ai_services_hub"
page_title: "Azure Resource Manager: azurerm_ai_foundry"
description: |-
Manages an AI Services Hub.
Manages an AI Foundry Hub.
---

# azurerm_ai_services_hub
# azurerm_ai_foundry

Manages an AI Services Hub.
Manages an AI Foundry Hub.

## Example Usage

Expand Down Expand Up @@ -59,7 +59,7 @@ resource "azurerm_ai_services" "example" {
sku_name = "S0"
}
resource "azurerm_ai_services_hub" "example" {
resource "azurerm_ai_foundry" "example" {
name = "exampleaihub"
location = azurerm_ai_services.example.location
resource_group_name = azurerm_resource_group.example.name
Expand All @@ -76,43 +76,43 @@ resource "azurerm_ai_services_hub" "example" {

The following arguments are supported:

* `name` - (Required) The name which should be used for this AI Services Hub. Changing this forces a new AI Services Hub to be created.
* `name` - (Required) The name which should be used for this AI Foundry Hub. Changing this forces a new AI Foundry Hub to be created.

* `location` - (Required) The Azure Region where the AI Services Hub should exist. Changing this forces a new AI Services Hub to be created.
* `location` - (Required) The Azure Region where the AI Foundry Hub should exist. Changing this forces a new AI Foundry Hub to be created.

* `resource_group_name` - (Required) The name of the Resource Group where the AI Services Hub should exist. Changing this forces a new AI Services Hub to be created.
* `resource_group_name` - (Required) The name of the Resource Group where the AI Foundry Hub should exist. Changing this forces a new AI Foundry Hub to be created.

* `identity` - (Required) A `identity` block as defined below.

* `key_vault_id` - (Required) The Key Vault ID that should be used by this AI Services Hub. Changing this forces a new AI Services Hub to be created.
* `key_vault_id` - (Required) The Key Vault ID that should be used by this AI Foundry Hub. Changing this forces a new AI Foundry Hub to be created.

* `storage_account_id` - (Required) The Storage Account ID that should be used by this AI Services Hub. Changing this forces a new AI Services Hub to be created.
* `storage_account_id` - (Required) The Storage Account ID that should be used by this AI Foundry Hub. Changing this forces a new AI Foundry Hub to be created.

---

* `application_insights_id` - (Optional) The Application Insights ID that should be used by this AI Services Hub.
* `application_insights_id` - (Optional) The Application Insights ID that should be used by this AI Foundry Hub.

* `container_registry_id` - (Optional) The Container Registry ID that should be used by this AI Services Hub.
* `container_registry_id` - (Optional) The Container Registry ID that should be used by this AI Foundry Hub.

* `description` - (Optional) The description of this AI Services Hub.
* `description` - (Optional) The description of this AI Foundry Hub.

* `encryption` - (Optional) An `encryption` block as defined below. Changing this forces a new AI Services Hub to be created.
* `encryption` - (Optional) An `encryption` block as defined below. Changing this forces a new AI Foundry Hub to be created.

* `friendly_name` - (Optional) The display name of this AI Services Hub.
* `friendly_name` - (Optional) The display name of this AI Foundry Hub.

* `high_business_impact_enabled` - (Optional) Whether High Business Impact (HBI) should be enabled or not. Enabling this setting will reduce diagnostic data collected by the service. Changing this forces a new AI Services Hub to be created. Defaults to `false`.
* `high_business_impact_enabled` - (Optional) Whether High Business Impact (HBI) should be enabled or not. Enabling this setting will reduce diagnostic data collected by the service. Changing this forces a new AI Foundry Hub to be created. Defaults to `false`.

-> **Note:** `high_business_impact_enabled` will be enabled by default when creating an AI Services Hub with `encryption` enabled.
-> **Note:** `high_business_impact_enabled` will be enabled by default when creating an AI Foundry Hub with `encryption` enabled.

* `image_build_compute_name` - (Optional) The compute name for image build of the AI Services Hub.
* `image_build_compute_name` - (Optional) The compute name for image build of the AI Foundry Hub.

* `managed_network` - (Optional) A `managed_network` block as defined below.

* `primary_user_assigned_identity` - (Optional) The user assigned identity ID that represents the AI Services Hub identity. This must be set when enabling encryption with a user assigned identity.
* `primary_user_assigned_identity` - (Optional) The user assigned identity ID that represents the AI Foundry Hub identity. This must be set when enabling encryption with a user assigned identity.

* `public_network_access` - (Optional) Whether public network access for this AI Service Hub should be enabled. Possible values include `Enabled` and `Disabled`. Defaults to `Enabled`.

* `tags` - (Optional) A mapping of tags which should be assigned to the AI Services Hub.
* `tags` - (Optional) A mapping of tags which should be assigned to the AI Foundry Hub.

---

Expand All @@ -130,27 +130,27 @@ A `encryption` block supports the following:

A `identity` block supports the following:

* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this AI Services Hub. Possible values are `SystemAssigned`, `UserAssigned`, `SystemAssigned, UserAssigned` (to enable both).
* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this AI Foundry Hub. Possible values are `SystemAssigned`, `UserAssigned`, `SystemAssigned, UserAssigned` (to enable both).

* `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this AI Services Hub.
* `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this AI Foundry Hub.

~> **NOTE:** This is required when `type` is set to `UserAssigned` or `SystemAssigned, UserAssigned`.

---

A `managed_network` block supports the following:

* `isolation_mode` - (Optional) The isolation mode of the AI Services Hub. Possible values are `Disabled`, `AllowOnlyApprovedOutbound`, and `AllowInternetOutbound`.
* `isolation_mode` - (Optional) The isolation mode of the AI Foundry Hub. Possible values are `Disabled`, `AllowOnlyApprovedOutbound`, and `AllowInternetOutbound`.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the AI Services Hub.
* `id` - The ID of the AI Foundry Hub.

* `discovery_url` - The URL for the discovery service to identify regional endpoints for AI Services Hub services.
* `discovery_url` - The URL for the discovery service to identify regional endpoints for AI Foundry Hub services.

* `workspace_id` - The immutable ID associated with this AI Services Hub.
* `workspace_id` - The immutable ID associated with this AI Foundry Hub.

---

Expand All @@ -164,15 +164,15 @@ An `identity` block exports the following:

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 1 hour) Used when creating the AI Services Hub.
* `read` - (Defaults to 5 minutes) Used when retrieving the AI Services Hub.
* `update` - (Defaults to 30 minutes) Used when updating the AI Services Hub.
* `delete` - (Defaults to 30 minutes) Used when deleting the AI Services Hub.
* `create` - (Defaults to 1 hour) Used when creating the AI Foundry Hub.
* `read` - (Defaults to 5 minutes) Used when retrieving the AI Foundry Hub.
* `update` - (Defaults to 30 minutes) Used when updating the AI Foundry Hub.
* `delete` - (Defaults to 30 minutes) Used when deleting the AI Foundry Hub.

## Import

AI Services Hubs can be imported using the `resource id`, e.g.
AI Foundry Hubs can be imported using the `resource id`, e.g.

```shell
terraform import azurerm_ai_services_hub.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/hub1
terraform import azurerm_ai_foundry.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/hub1
```
50 changes: 25 additions & 25 deletions .../docs/r/ai_services_project.html.markdown → ...e/docs/r/ai_foundry_project.html.markdown
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
subcategory: "AI Services"
subcategory: "Machine Learning"
layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_ai_services_project"
page_title: "Azure Resource Manager: azurerm_ai_foundry_project"
description: |-
Manages an AI Services Project.
Manages an AI Foundry Project.
---

# azurerm_ai_services_project
# azurerm_ai_foundry_project

Manages an AI Services Project.
Manages an AI Foundry Project.

## Example Usage

Expand Down Expand Up @@ -59,7 +59,7 @@ resource "azurerm_ai_services" "example" {
sku_name = "S0"
}
resource "azurerm_ai_services_hub" "example" {
resource "azurerm_ai_foundry" "example" {
name = "exampleaihub"
location = azurerm_ai_services.example.location
resource_group_name = azurerm_resource_group.example.name
Expand All @@ -71,7 +71,7 @@ resource "azurerm_ai_services_hub" "example" {
}
}
resource "azurerm_ai_services_project" "example" {
resource "azurerm_ai_foundry_project" "example" {
name = "example"
location = azurerm_ai_services_hub.example.location
ai_services_hub_id = azurerm_ai_services_hub.example.id
Expand All @@ -82,43 +82,43 @@ resource "azurerm_ai_services_project" "example" {

The following arguments are supported:

* `name` - (Required) The name which should be used for this AI Services Project. Changing this forces a new AI Services Project to be created.
* `name` - (Required) The name which should be used for this AI Foundry Project. Changing this forces a new AI Foundry Project to be created.

* `location` - (Required) The Azure Region where the AI Services Project should exist. Changing this forces a new AI Services Project to be created.
* `location` - (Required) The Azure Region where the AI Foundry Project should exist. Changing this forces a new AI Foundry Project to be created.

* `ai_services_hub_id` - (Required) The AI Services Hub ID under which this Project should be created. Changing this forces a new AI Services Project to be created.
* `ai_services_hub_id` - (Required) The AI Services Hub ID under which this Project should be created. Changing this forces a new AI Foundry Project to be created.

---

* `description` - (Optional) The description of this AI Services Project.
* `description` - (Optional) The description of this AI Foundry Project.

* `friendly_name` - (Optional) The display name of this AI Services Project.
* `friendly_name` - (Optional) The display name of this AI Foundry Project.

* `high_business_impact_enabled` - (Optional) Whether High Business Impact (HBI) should be enabled or not. Enabling this setting will reduce diagnostic data collected by the service. Changing this forces a new AI Services Project to be created. Defaults to `false`.
* `high_business_impact_enabled` - (Optional) Whether High Business Impact (HBI) should be enabled or not. Enabling this setting will reduce diagnostic data collected by the service. Changing this forces a new AI Foundry Project to be created. Defaults to `false`.

* `identity` - (Optional) A `identity` block as defined below.

* `image_build_compute_name` - (Optional) The compute name for image build of the AI Services Project.
* `image_build_compute_name` - (Optional) The compute name for image build of the AI Foundry Project.

* `tags` - (Optional) A mapping of tags which should be assigned to the AI Services Project.
* `tags` - (Optional) A mapping of tags which should be assigned to the AI Foundry Project.

---

A `identity` block supports the following:

* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this AI Services Project. Possible values are `SystemAssigned`, `UserAssigned`, `SystemAssigned, UserAssigned` (to enable both).
* `type` - (Required) Specifies the type of Managed Service Identity that should be configured on this AI Foundry Project. Possible values are `SystemAssigned`, `UserAssigned`, `SystemAssigned, UserAssigned` (to enable both).

* `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this AI Services Project.
* `identity_ids` - (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this AI Foundry Project.

~> **NOTE:** This is required when `type` is set to `UserAssigned` or `SystemAssigned, UserAssigned`.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the AI Services Project.
* `id` - The ID of the AI Foundry Project.

* `project_id` - The immutable project ID associated with this AI Services Project.
* `project_id` - The immutable project ID associated with this AI Foundry Project.

---

Expand All @@ -132,15 +132,15 @@ An `identity` block exports the following:

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 30 hour) Used when creating the AI Services Project.
* `read` - (Defaults to 5 minutes) Used when retrieving the AI Services Project.
* `update` - (Defaults to 30 minutes) Used when updating the AI Services Project.
* `delete` - (Defaults to 30 minutes) Used when deleting the AI Services Project.
* `create` - (Defaults to 30 hour) Used when creating the AI Foundry Project.
* `read` - (Defaults to 5 minutes) Used when retrieving the AI Foundry Project.
* `update` - (Defaults to 30 minutes) Used when updating the AI Foundry Project.
* `delete` - (Defaults to 30 minutes) Used when deleting the AI Foundry Project.

## Import

AI Services Projects can be imported using the `resource id`, e.g.
AI Foundry Projects can be imported using the `resource id`, e.g.

```shell
terraform import azurerm_ai_services_project.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/project1
terraform import azurerm_ai_foundry_project.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.MachineLearningServices/workspaces/project1
```
2 changes: 1 addition & 1 deletion website/docs/r/ai_services.html.markdown
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
subcategory: "AI Services"
subcategory: "Cognitive Services"
layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_ai_services"
description: |-
Expand Down

0 comments on commit 399b9e4

Please sign in to comment.