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 sageMakerApps 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.AwsConnector/sageMakerApps resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/sageMakerApps@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
appArn: 'string'
appName: 'string'
appType: 'string'
domainId: 'string'
resourceSpec: {
instanceType: 'string'
sageMakerImageArn: 'string'
sageMakerImageVersionArn: 'string'
}
tags: [
{
key: 'string'
value: 'string'
}
]
userProfileName: 'string'
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/sageMakerApps
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | SageMakerAppProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AwsSageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| appArn | The Amazon Resource Name (ARN) of the app. | string |
| appName | The name of the app. | string |
| appType | The type of app. | 'Canvas' 'JupyterServer' 'KernelGateway' 'RSessionGateway' 'RStudioServerPro' |
| domainId | The domain ID. | string |
| resourceSpec | The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. | ResourceSpec |
| tags | A list of tags to apply to the app. | TagAutoGenerated51[] |
| userProfileName | The user profile name. | string |
ResourceSpec
| Name | Description | Value |
|---|---|---|
| instanceType | The instance type that the image version runs on. | 'ml.c5.12xlarge' 'ml.c5.18xlarge' 'ml.c5.24xlarge' 'ml.c5.2xlarge' 'ml.c5.4xlarge' 'ml.c5.9xlarge' 'ml.c5.large' 'ml.c5.xlarge' 'ml.g4dn.12xlarge' 'ml.g4dn.16xlarge' 'ml.g4dn.2xlarge' 'ml.g4dn.4xlarge' 'ml.g4dn.8xlarge' 'ml.g4dn.xlarge' 'ml.g5.12xlarge' 'ml.g5.16xlarge' 'ml.g5.24xlarge' 'ml.g5.2xlarge' 'ml.g5.48xlarge' 'ml.g5.4xlarge' 'ml.g5.8xlarge' 'ml.g5.xlarge' 'ml.geospatial.interactive' 'ml.m5.12xlarge' 'ml.m5.16xlarge' 'ml.m5.24xlarge' 'ml.m5.2xlarge' 'ml.m5.4xlarge' 'ml.m5.8xlarge' 'ml.m5.large' 'ml.m5.xlarge' 'ml.m5d.12xlarge' 'ml.m5d.16xlarge' 'ml.m5d.24xlarge' 'ml.m5d.2xlarge' 'ml.m5d.4xlarge' 'ml.m5d.8xlarge' 'ml.m5d.large' 'ml.m5d.xlarge' 'ml.p3.16xlarge' 'ml.p3.2xlarge' 'ml.p3.8xlarge' 'ml.p3dn.24xlarge' 'ml.p4d.24xlarge' 'ml.p4de.24xlarge' 'ml.r5.12xlarge' 'ml.r5.16xlarge' 'ml.r5.24xlarge' 'ml.r5.2xlarge' 'ml.r5.4xlarge' 'ml.r5.8xlarge' 'ml.r5.large' 'ml.r5.xlarge' 'ml.t3.2xlarge' 'ml.t3.large' 'ml.t3.medium' 'ml.t3.micro' 'ml.t3.small' 'ml.t3.xlarge' 'ml.trn1.2xlarge' 'ml.trn1.32xlarge' 'ml.trn1n.32xlarge' 'system' |
| sageMakerImageArn | The ARN of the SageMaker image that the image version belongs to. | string |
| sageMakerImageVersionArn | The ARN of the image version created on the instance. | string |
SageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsSageMakerAppProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | SageMakerAppPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
SageMakerAppPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated51
| Name | Description | Value |
|---|---|---|
| key | Property key | string |
| value | Property value | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The sageMakerApps 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.AwsConnector/sageMakerApps resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/sageMakerApps",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"appArn": "string",
"appName": "string",
"appType": "string",
"domainId": "string",
"resourceSpec": {
"instanceType": "string",
"sageMakerImageArn": "string",
"sageMakerImageVersionArn": "string"
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"userProfileName": "string"
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/sageMakerApps
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | SageMakerAppProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/sageMakerApps' |
AwsSageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| appArn | The Amazon Resource Name (ARN) of the app. | string |
| appName | The name of the app. | string |
| appType | The type of app. | 'Canvas' 'JupyterServer' 'KernelGateway' 'RSessionGateway' 'RStudioServerPro' |
| domainId | The domain ID. | string |
| resourceSpec | The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. | ResourceSpec |
| tags | A list of tags to apply to the app. | TagAutoGenerated51[] |
| userProfileName | The user profile name. | string |
ResourceSpec
| Name | Description | Value |
|---|---|---|
| instanceType | The instance type that the image version runs on. | 'ml.c5.12xlarge' 'ml.c5.18xlarge' 'ml.c5.24xlarge' 'ml.c5.2xlarge' 'ml.c5.4xlarge' 'ml.c5.9xlarge' 'ml.c5.large' 'ml.c5.xlarge' 'ml.g4dn.12xlarge' 'ml.g4dn.16xlarge' 'ml.g4dn.2xlarge' 'ml.g4dn.4xlarge' 'ml.g4dn.8xlarge' 'ml.g4dn.xlarge' 'ml.g5.12xlarge' 'ml.g5.16xlarge' 'ml.g5.24xlarge' 'ml.g5.2xlarge' 'ml.g5.48xlarge' 'ml.g5.4xlarge' 'ml.g5.8xlarge' 'ml.g5.xlarge' 'ml.geospatial.interactive' 'ml.m5.12xlarge' 'ml.m5.16xlarge' 'ml.m5.24xlarge' 'ml.m5.2xlarge' 'ml.m5.4xlarge' 'ml.m5.8xlarge' 'ml.m5.large' 'ml.m5.xlarge' 'ml.m5d.12xlarge' 'ml.m5d.16xlarge' 'ml.m5d.24xlarge' 'ml.m5d.2xlarge' 'ml.m5d.4xlarge' 'ml.m5d.8xlarge' 'ml.m5d.large' 'ml.m5d.xlarge' 'ml.p3.16xlarge' 'ml.p3.2xlarge' 'ml.p3.8xlarge' 'ml.p3dn.24xlarge' 'ml.p4d.24xlarge' 'ml.p4de.24xlarge' 'ml.r5.12xlarge' 'ml.r5.16xlarge' 'ml.r5.24xlarge' 'ml.r5.2xlarge' 'ml.r5.4xlarge' 'ml.r5.8xlarge' 'ml.r5.large' 'ml.r5.xlarge' 'ml.t3.2xlarge' 'ml.t3.large' 'ml.t3.medium' 'ml.t3.micro' 'ml.t3.small' 'ml.t3.xlarge' 'ml.trn1.2xlarge' 'ml.trn1.32xlarge' 'ml.trn1n.32xlarge' 'system' |
| sageMakerImageArn | The ARN of the SageMaker image that the image version belongs to. | string |
| sageMakerImageVersionArn | The ARN of the image version created on the instance. | string |
SageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsSageMakerAppProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | SageMakerAppPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
SageMakerAppPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated51
| Name | Description | Value |
|---|---|---|
| key | Property key | string |
| value | Property value | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The sageMakerApps 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.AwsConnector/sageMakerApps resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/sageMakerApps@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
appArn = "string"
appName = "string"
appType = "string"
domainId = "string"
resourceSpec = {
instanceType = "string"
sageMakerImageArn = "string"
sageMakerImageVersionArn = "string"
}
tags = [
{
key = "string"
value = "string"
}
]
userProfileName = "string"
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/sageMakerApps
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | SageMakerAppProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/sageMakerApps@2024-12-01" |
AwsSageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| appArn | The Amazon Resource Name (ARN) of the app. | string |
| appName | The name of the app. | string |
| appType | The type of app. | 'Canvas' 'JupyterServer' 'KernelGateway' 'RSessionGateway' 'RStudioServerPro' |
| domainId | The domain ID. | string |
| resourceSpec | The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. | ResourceSpec |
| tags | A list of tags to apply to the app. | TagAutoGenerated51[] |
| userProfileName | The user profile name. | string |
ResourceSpec
| Name | Description | Value |
|---|---|---|
| instanceType | The instance type that the image version runs on. | 'ml.c5.12xlarge' 'ml.c5.18xlarge' 'ml.c5.24xlarge' 'ml.c5.2xlarge' 'ml.c5.4xlarge' 'ml.c5.9xlarge' 'ml.c5.large' 'ml.c5.xlarge' 'ml.g4dn.12xlarge' 'ml.g4dn.16xlarge' 'ml.g4dn.2xlarge' 'ml.g4dn.4xlarge' 'ml.g4dn.8xlarge' 'ml.g4dn.xlarge' 'ml.g5.12xlarge' 'ml.g5.16xlarge' 'ml.g5.24xlarge' 'ml.g5.2xlarge' 'ml.g5.48xlarge' 'ml.g5.4xlarge' 'ml.g5.8xlarge' 'ml.g5.xlarge' 'ml.geospatial.interactive' 'ml.m5.12xlarge' 'ml.m5.16xlarge' 'ml.m5.24xlarge' 'ml.m5.2xlarge' 'ml.m5.4xlarge' 'ml.m5.8xlarge' 'ml.m5.large' 'ml.m5.xlarge' 'ml.m5d.12xlarge' 'ml.m5d.16xlarge' 'ml.m5d.24xlarge' 'ml.m5d.2xlarge' 'ml.m5d.4xlarge' 'ml.m5d.8xlarge' 'ml.m5d.large' 'ml.m5d.xlarge' 'ml.p3.16xlarge' 'ml.p3.2xlarge' 'ml.p3.8xlarge' 'ml.p3dn.24xlarge' 'ml.p4d.24xlarge' 'ml.p4de.24xlarge' 'ml.r5.12xlarge' 'ml.r5.16xlarge' 'ml.r5.24xlarge' 'ml.r5.2xlarge' 'ml.r5.4xlarge' 'ml.r5.8xlarge' 'ml.r5.large' 'ml.r5.xlarge' 'ml.t3.2xlarge' 'ml.t3.large' 'ml.t3.medium' 'ml.t3.micro' 'ml.t3.small' 'ml.t3.xlarge' 'ml.trn1.2xlarge' 'ml.trn1.32xlarge' 'ml.trn1n.32xlarge' 'system' |
| sageMakerImageArn | The ARN of the SageMaker image that the image version belongs to. | string |
| sageMakerImageVersionArn | The ARN of the image version created on the instance. | string |
SageMakerAppProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsSageMakerAppProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | SageMakerAppPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
SageMakerAppPropertiesAwsTags
| Name | Description | Value |
|---|
TagAutoGenerated51
| Name | Description | Value |
|---|---|---|
| key | Property key | string |
| value | Property value | string |
TrackedResourceTags
| Name | Description | Value |
|---|