Поделиться через


Extensions - Create

Создайте расширение кластера Kubernetes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01

Параметры URI

Имя В Обязательно Тип Описание
clusterName
path True

string

Имя кластера Kubernetes.

clusterResourceName
path True

string

Имя ресурса кластера Kubernetes, т. е. managedClusters, connectedClusters, provisionedClusters.

clusterRp
path True

string

RP кластера Kubernetes — microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

extensionName
path True

string

Имя расширения.

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
identity

Identity

Удостоверение ресурса расширения

plan

Plan

Сведения о плане.

properties.aksAssignedIdentity

AksAssignedIdentity

Удостоверение ресурса Расширения в кластере AKS

properties.autoUpgradeMinorVersion

boolean

Пометка, чтобы отметить, участвует ли это расширение в автоматическом обновлении дополнительной версии.

properties.configurationProtectedSettings

object

Конфиденциальные параметры конфигурации в виде пар "имя-значение" для настройки этого расширения.

properties.configurationSettings

object

Параметры конфигурации в виде пар "имя-значение" для настройки этого расширения.

properties.extensionType

string

Тип расширения, экземпляром которого является этот ресурс. Это должен быть один из типов расширений, зарегистрированных в Microsoft.KubernetesConfiguration издателем расширений.

properties.releaseTrain

string

ReleaseTrain это расширение используется для автоматического обновления (например, стабильного, предварительного просмотра и т. д.) только в том случае, если параметр autoUpgradeMinorVersion имеет значение true.

properties.scope

Scope

Область, в которой устанавливается расширение.

properties.statuses

ExtensionStatus[]

Состояние из этого расширения.

properties.version

string

Указанная пользователем версия расширения для этого расширения для "закрепить". Чтобы использовать "version", параметр autoUpgradeMinorVersion должен иметь значение false.

Ответы

Имя Тип Описание
200 OK

Extension

Запрос для существующего ресурса успешно получен.

201 Created

Extension

Запрос успешно получен.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Create Extension
Create Extension with Plan

Create Extension

Образец запроса

PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor?api-version=2023-05-01

{
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "configurationProtectedSettings": {
      "omsagent.secret.key": "secretKeyValue01"
    }
  }
}

Пример ответа

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/operationId?api-version=2023-05-01
{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "ClusterMonitor",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": false,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "provisioningState": "Creating",
    "currentVersion": null,
    "statuses": [],
    "isSystemExtension": false
  }
}
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H
{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "ClusterMonitor",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": false,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "fakeTokenPlaceholder",
      "omsagent.env.clusterName": "clusterName1"
    },
    "provisioningState": "Succeeded",
    "currentVersion": "0.1.4",
    "statuses": [],
    "isSystemExtension": false
  }
}

Create Extension with Plan

Образец запроса

PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote?api-version=2023-05-01

{
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  }
}

Пример ответа

Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/operationId?api-version=2022-04-01-preview
{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "azureVote",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  },
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "provisioningState": "Creating",
    "statuses": [],
    "currentVersion": null,
    "isSystemExtension": false
  }
}
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H
{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "azureVote",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "plan": {
    "name": "azure-vote-standard",
    "publisher": "Microsoft",
    "product": "azure-vote-standard-offer-id"
  },
  "properties": {
    "extensionType": "azure-vote",
    "autoUpgradeMinorVersion": true,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "provisioningState": "Creating",
    "statuses": [],
    "currentVersion": "0.1.4",
    "isSystemExtension": false
  }
}

Определения

Имя Описание
AksAssignedIdentity

Удостоверение ресурса Расширения в кластере AKS

AKSIdentityType

Тип удостоверения.

createdByType

Тип удостоверения, создавшего ресурс.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

Extension

Объект Extension.

ExtensionStatus

Состояние расширения.

Identity

Удостоверение ресурса.

LevelType

Уровень состояния.

Plan

План для ресурса.

ProvisioningState

Состояние установки этого расширения.

ResourceIdentityType

Тип удостоверения.

Scope

Область расширения. Это может быть кластер или пространство имен; но не оба.

ScopeCluster

Указывает, что область расширения — Cluster.

ScopeNamespace

Указывает, что область расширения — пространство имен.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

AksAssignedIdentity

Удостоверение ресурса Расширения в кластере AKS

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

AKSIdentityType

Тип удостоверения.

AKSIdentityType

Тип удостоверения.

Имя Тип Описание
SystemAssigned

string

UserAssigned

string

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

Extension

Объект Extension.

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Удостоверение ресурса расширения

name

string

Имя ресурса.

plan

Plan

Сведения о плане.

properties.aksAssignedIdentity

AksAssignedIdentity

Удостоверение ресурса Расширения в кластере AKS

properties.autoUpgradeMinorVersion

boolean

True

Пометка, чтобы отметить, участвует ли это расширение в автоматическом обновлении дополнительной версии.

properties.configurationProtectedSettings

object

Конфиденциальные параметры конфигурации в виде пар "имя-значение" для настройки этого расширения.

properties.configurationSettings

object

Параметры конфигурации в виде пар "имя-значение" для настройки этого расширения.

properties.currentVersion

string

Установленная в настоящее время версия расширения.

properties.customLocationSettings

object

Свойства настраиваемых параметров расположения.

properties.errorInfo

ErrorDetail

Сведения об ошибках из агента, например ошибки во время установки.

properties.extensionType

string

Тип расширения, экземпляром которого является этот ресурс. Это должен быть один из типов расширений, зарегистрированных в Microsoft.KubernetesConfiguration издателем расширений.

properties.isSystemExtension

boolean

False

Флаг, чтобы отметить, является ли это расширение системным расширением

properties.packageUri

string

URI пакета Helm

properties.provisioningState

ProvisioningState

Состояние установки этого расширения.

properties.releaseTrain

string

Stable

ReleaseTrain это расширение используется для автоматического обновления (например, стабильного, предварительного просмотра и т. д.) только в том случае, если параметр autoUpgradeMinorVersion имеет значение true.

properties.scope

Scope

Область, в которой устанавливается расширение.

properties.statuses

ExtensionStatus[]

Состояние из этого расширения.

properties.version

string

Указанная пользователем версия расширения для этого расширения для "закрепить". Чтобы использовать "version", параметр autoUpgradeMinorVersion должен иметь значение false.

systemData

systemData

Метаданные верхнего уровня https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ExtensionStatus

Состояние расширения.

Имя Тип Default value Описание
code

string

Код состояния, предоставляемый расширением

displayStatus

string

Краткое описание состояния расширения.

level

LevelType

Information

Уровень состояния.

message

string

Подробное сообщение о состоянии из расширения.

time

string

DateLiteral (по ISO8601) с указанием времени установки.

Identity

Удостоверение ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

ResourceIdentityType

Тип удостоверения.

LevelType

Уровень состояния.

Имя Тип Описание
Error

string

Information

string

Warning

string

Plan

План для ресурса.

Имя Тип Описание
name

string

Определяемое пользователем имя приобретаемого артефакта стороннего производителя.

product

string

Артефакт 3-й партии, который приобретается. Например, NewRelic. Продукт сопоставляется с OfferID, заданным для артефакта во время подключения к рынке данных.

promotionCode

string

Издатель предоставил код повышения уровня, подготовленный на рынке данных для указанного продукта или артефакта.

publisher

string

Издатель приобретаемого артефакта 3-й стороны. Например, NewRelic

version

string

Версия нужного продукта или артефакта.

ProvisioningState

Состояние установки этого расширения.

Имя Тип Описание
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

Тип удостоверения.

Имя Тип Описание
SystemAssigned

string

Scope

Область расширения. Это может быть кластер или пространство имен; но не оба.

Имя Тип Описание
cluster

ScopeCluster

Указывает, что область расширения — Cluster.

namespace

ScopeNamespace

Указывает, что область расширения — пространство имен.

ScopeCluster

Указывает, что область расширения — Cluster.

Имя Тип Описание
releaseNamespace

string

Пространство имен, в котором должно быть размещено расширение Release, для расширения с областью действия кластера. Если это пространство имен не существует, оно будет создано

ScopeNamespace

Указывает, что область расширения — пространство имен.

Имя Тип Описание
targetNamespace

string

Пространство имен, в котором будет создано расширение для расширения пространства имен. Если это пространство имен не существует, оно будет создано

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.