你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ExtendedLocation customLocations

  • 项目

Bicep 资源定义

customLocations 资源类型可以部署到：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ExtendedLocation/customLocations 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authentication: {
      type: 'string'
      value: 'string'
    }
    clusterExtensionIds: [
      'string'
    ]
    displayName: 'string'
    hostResourceId: 'string'
    hostType: 'Kubernetes'
    namespace: 'string'
    provisioningState: 'string'
  }
}

属性值

customLocations

名称 说明 值
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
identity 资源的标识。 标识
properties 特定于自定义位置的属性集 CustomLocationProperties

标识

名称 说明 Value
type 标识类型。 “None”
“SystemAssigned”

CustomLocationProperties

名称 说明 值
身份验证 这是可选输入，包含应用于生成命名空间的身份验证。 CustomLocationPropertiesAuthentication
clusterExtensionIds 包含对加载项的引用，该加载项包含用于部署 CRD 和运算符的图表。 string[]
displayName 自定义位置位置的显示名称。 字符串
hostResourceId 连接的群集或 AKS 群集。 自定义位置 RP 将针对 listAdminCredentials 权限执行 checkAccess API。 字符串
hostType 自定义位置引用的主机类型 (Kubernetes 等...) 。 “Kubernetes”
命名空间 将在指定群集上创建的 Kubernetes 命名空间。 string
provisioningState 自定义位置的预配状态。 字符串

CustomLocationPropertiesAuthentication

名称 说明 Value
type 自定义位置身份验证的类型 string
value kubeconfig 值。 字符串

ARM 模板资源定义

customLocations 资源类型可以部署到：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ExtendedLocation/customLocations 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ExtendedLocation/customLocations",
  "apiVersion": "2021-08-31-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authentication": {
      "type": "string",
      "value": "string"
    },
    "clusterExtensionIds": [ "string" ],
    "displayName": "string",
    "hostResourceId": "string",
    "hostType": "Kubernetes",
    "namespace": "string",
    "provisioningState": "string"
  }
}

属性值

customLocations

名称 说明 Value
type 资源类型 'Microsoft.ExtendedLocation/customLocations'
apiVersion 资源 API 版本 '2021-08-31-preview'
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
identity 资源的标识。 标识
properties 特定于自定义位置的属性集 CustomLocationProperties

标识

名称 说明 Value
type 标识类型。 “None”
“SystemAssigned”

CustomLocationProperties

名称 说明 值
身份验证 这是可选输入，包含应用于生成命名空间的身份验证。 CustomLocationPropertiesAuthentication
clusterExtensionIds 包含对加载项的引用，该加载项包含用于部署 CRD 和运算符的图表。 string[]
displayName 自定义位置位置的显示名称。 字符串
hostResourceId 连接的群集或 AKS 群集。 自定义位置 RP 将针对 listAdminCredentials 权限执行检查Access API。 字符串
hostType 自定义位置引用的主机类型 (Kubernetes 等...) 。 “Kubernetes”
命名空间 将在指定群集上创建的 Kubernetes 命名空间。 字符串
provisioningState 自定义位置的预配状态。 字符串

CustomLocationPropertiesAuthentication

名称 说明 Value
type 自定义位置身份验证的类型 string
value kubeconfig 值。 字符串

Terraform (AzAPI 提供程序) 资源定义

customLocations 资源类型可部署到：

  • 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ExtendedLocation/customLocations 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ExtendedLocation/customLocations@2021-08-31-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authentication = {
        type = "string"
        value = "string"
      }
      clusterExtensionIds = [
        "string"
      ]
      displayName = "string"
      hostResourceId = "string"
      hostType = "Kubernetes"
      namespace = "string"
      provisioningState = "string"
    }
  })
}

属性值

customLocations

名称 说明 Value
type 资源类型 “Microsoft.ExtendedLocation/customLocations@2021-08-31-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
identity 资源的标识。 标识
properties 特定于自定义位置的属性集 CustomLocationProperties

标识

名称 说明 Value
type 标识类型。 “SystemAssigned”

CustomLocationProperties

名称 说明 值
身份验证 这是可选输入，包含应用于生成命名空间的身份验证。 CustomLocationPropertiesAuthentication
clusterExtensionIds 包含对加载项的引用，该加载项包含用于部署 CRD 和运算符的图表。 string[]
displayName 自定义位置位置的显示名称。 string
hostResourceId 连接的群集或 AKS 群集。 自定义位置 RP 将针对 listAdminCredentials 权限执行 checkAccess API。 字符串
hostType 自定义位置引用的主机类型 (Kubernetes 等...) 。 “Kubernetes”
命名空间 将在指定群集上创建的 Kubernetes 命名空间。 string
provisioningState 自定义位置的预配状态。 字符串

CustomLocationPropertiesAuthentication

名称 说明 Value
type 自定义位置身份验证的类型 string
value kubeconfig 值。 字符串