Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The services/workspaces/environments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiCenter/services/workspaces/environments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiCenter/services/workspaces/environments@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
customProperties: any(...)
description: 'string'
kind: 'string'
onboarding: {
developerPortalUri: [
'string'
]
instructions: 'string'
}
server: {
managementPortalUri: [
'string'
]
type: 'string'
}
title: 'string'
}
}
Property Values
Microsoft.ApiCenter/services/workspaces/environments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[a-zA-Z0-9-]{3,90}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: services/workspaces |
| properties | The resource-specific properties for this resource. | EnvironmentProperties |
EnvironmentProperties
| Name | Description | Value |
|---|---|---|
| customProperties | The custom metadata defined for API catalog entities. | any |
| description | The environment description. | string |
| kind | Environment kind. | 'development' 'production' 'staging' 'testing' (required) |
| onboarding | Environment onboarding information | Onboarding |
| server | Server information of the environment. | EnvironmentServer |
| title | Environment title. | string Constraints: Min length = 1 Max length = 50 (required) |
EnvironmentServer
| Name | Description | Value |
|---|---|---|
| managementPortalUri | The location of the management portal | string[] |
| type | Type of the server that represents the environment. | 'Apigee API Management' 'AWS API Gateway' 'Azure API Management' 'Azure compute service' 'Kong API Gateway' 'Kubernetes' 'MuleSoft API Management' |
Onboarding
| Name | Description | Value |
|---|---|---|
| developerPortalUri | The location of the development portal | string[] |
| instructions | Onboarding guide. | string |
ARM template resource definition
The services/workspaces/environments resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiCenter/services/workspaces/environments resource, add the following JSON to your template.
{
"type": "Microsoft.ApiCenter/services/workspaces/environments",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"customProperties": {},
"description": "string",
"kind": "string",
"onboarding": {
"developerPortalUri": [ "string" ],
"instructions": "string"
},
"server": {
"managementPortalUri": [ "string" ],
"type": "string"
},
"title": "string"
}
}
Property Values
Microsoft.ApiCenter/services/workspaces/environments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[a-zA-Z0-9-]{3,90}$ (required) |
| properties | The resource-specific properties for this resource. | EnvironmentProperties |
| type | The resource type | 'Microsoft.ApiCenter/services/workspaces/environments' |
EnvironmentProperties
| Name | Description | Value |
|---|---|---|
| customProperties | The custom metadata defined for API catalog entities. | any |
| description | The environment description. | string |
| kind | Environment kind. | 'development' 'production' 'staging' 'testing' (required) |
| onboarding | Environment onboarding information | Onboarding |
| server | Server information of the environment. | EnvironmentServer |
| title | Environment title. | string Constraints: Min length = 1 Max length = 50 (required) |
EnvironmentServer
| Name | Description | Value |
|---|---|---|
| managementPortalUri | The location of the management portal | string[] |
| type | Type of the server that represents the environment. | 'Apigee API Management' 'AWS API Gateway' 'Azure API Management' 'Azure compute service' 'Kong API Gateway' 'Kubernetes' 'MuleSoft API Management' |
Onboarding
| Name | Description | Value |
|---|---|---|
| developerPortalUri | The location of the development portal | string[] |
| instructions | Onboarding guide. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The services/workspaces/environments resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiCenter/services/workspaces/environments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiCenter/services/workspaces/environments@2024-06-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
customProperties = ?
description = "string"
kind = "string"
onboarding = {
developerPortalUri = [
"string"
]
instructions = "string"
}
server = {
managementPortalUri = [
"string"
]
type = "string"
}
title = "string"
}
}
}
Property Values
Microsoft.ApiCenter/services/workspaces/environments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 90 Pattern = ^[a-zA-Z0-9-]{3,90}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: services/workspaces |
| properties | The resource-specific properties for this resource. | EnvironmentProperties |
| type | The resource type | "Microsoft.ApiCenter/services/workspaces/environments@2024-06-01-preview" |
EnvironmentProperties
| Name | Description | Value |
|---|---|---|
| customProperties | The custom metadata defined for API catalog entities. | any |
| description | The environment description. | string |
| kind | Environment kind. | 'development' 'production' 'staging' 'testing' (required) |
| onboarding | Environment onboarding information | Onboarding |
| server | Server information of the environment. | EnvironmentServer |
| title | Environment title. | string Constraints: Min length = 1 Max length = 50 (required) |
EnvironmentServer
| Name | Description | Value |
|---|---|---|
| managementPortalUri | The location of the management portal | string[] |
| type | Type of the server that represents the environment. | 'Apigee API Management' 'AWS API Gateway' 'Azure API Management' 'Azure compute service' 'Kong API Gateway' 'Kubernetes' 'MuleSoft API Management' |
Onboarding
| Name | Description | Value |
|---|---|---|
| developerPortalUri | The location of the development portal | string[] |
| instructions | Onboarding guide. | string |