Bagikan melalui


Extensions - Create

Buat Ekstensi Kluster Kubernetes baru.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
clusterName
path True

string

Nama kluster kubernetes.

clusterResourceName
path True

string

Nama sumber daya kluster Kubernetes - yaitu managedClusters, connectedClusters, provisionedClusters.

clusterRp
path True

string

RP kluster Kubernetes - yaitu Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

extensionName
path True

string

Nama Ekstensi.

resourceGroupName
path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

subscriptionId
path True

string

ID langganan target.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama Jenis Deskripsi
identity

Identity

Identitas sumber daya Ekstensi

plan

Plan

Informasi rencana.

properties.aksAssignedIdentity

AksAssignedIdentity

Identitas sumber daya Ekstensi dalam kluster AKS

properties.autoUpgradeMinorVersion

boolean

Beri bendera untuk dicatat apakah ekstensi ini berpartisipasi dalam peningkatan otomatis versi minor, atau tidak.

properties.configurationProtectedSettings

object

Pengaturan konfigurasi yang sensitif, sebagai pasangan nama-nilai untuk mengonfigurasi ekstensi ini.

properties.configurationSettings

object

Pengaturan konfigurasi, sebagai pasangan nama-nilai untuk mengonfigurasi ekstensi ini.

properties.extensionType

string

Jenis Ekstensi, di mana sumber daya ini adalah instans. Ini harus menjadi salah satu Jenis Ekstensi yang terdaftar di Microsoft.KubernetesConfiguration oleh penerbit Ekstensi.

properties.releaseTrain

string

ReleaseTrain ekstensi ini berpartisipasi dalam untuk peningkatan otomatis (misalnya Stabil, Pratinjau, dll.) - hanya jika autoUpgradeMinorVersion adalah 'true'.

properties.scope

Scope

Cakupan tempat ekstensi diinstal.

properties.statuses

ExtensionStatus[]

Status dari ekstensi ini.

properties.version

string

Versi ekstensi yang ditentukan pengguna untuk ekstensi ini ke 'pin'. Untuk menggunakan 'version', autoUpgradeMinorVersion harus 'false'.

Respons

Nama Jenis Deskripsi
200 OK

Extension

Permintaan berhasil diterima untuk sumber daya yang ada.

201 Created

Extension

Permintaan berhasil diterima.

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Create Extension
Create Extension with Plan

Create Extension

Permintaan sampel

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"
    }
  }
}

Respon sampel

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

Permintaan sampel

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"
  }
}

Respon sampel

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
  }
}

Definisi

Nama Deskripsi
AksAssignedIdentity

Identitas sumber daya Ekstensi dalam kluster AKS

AKSIdentityType

Jenis identitas.

createdByType

Jenis identitas yang membuat sumber daya.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan

Extension

Objek Ekstensi.

ExtensionStatus

Status dari ekstensi.

Identity

Identitas untuk sumber daya.

LevelType

Tingkat status.

Plan

Rencanakan untuk sumber daya.

ProvisioningState

Status penginstalan ekstensi ini.

ResourceIdentityType

Jenis identitas.

Scope

Cakupan ekstensi. Ini bisa berupa Kluster atau Namespace; tapi tidak keduanya.

ScopeCluster

Menentukan bahwa cakupan ekstensi adalah Kluster

ScopeNamespace

Menentukan bahwa cakupan ekstensi adalah Namespace

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AksAssignedIdentity

Identitas sumber daya Ekstensi dalam kluster AKS

Nama Jenis Deskripsi
principalId

string

ID utama identitas sumber daya.

tenantId

string

ID penyewa sumber daya.

type

AKSIdentityType

Jenis identitas.

AKSIdentityType

Jenis identitas.

Nama Jenis Deskripsi
SystemAssigned

string

UserAssigned

string

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

Extension

Objek Ekstensi.

Nama Jenis Nilai default Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identitas sumber daya Ekstensi

name

string

Nama sumber daya.

plan

Plan

Informasi rencana.

properties.aksAssignedIdentity

AksAssignedIdentity

Identitas sumber daya Ekstensi dalam kluster AKS

properties.autoUpgradeMinorVersion

boolean

True

Beri bendera untuk dicatat apakah ekstensi ini berpartisipasi dalam peningkatan otomatis versi minor, atau tidak.

properties.configurationProtectedSettings

object

Pengaturan konfigurasi yang sensitif, sebagai pasangan nama-nilai untuk mengonfigurasi ekstensi ini.

properties.configurationSettings

object

Pengaturan konfigurasi, sebagai pasangan nama-nilai untuk mengonfigurasi ekstensi ini.

properties.currentVersion

string

Versi ekstensi yang saat ini diinstal.

properties.customLocationSettings

object

Properti pengaturan Lokasi Kustom.

properties.errorInfo

ErrorDetail

Informasi kesalahan dari Agen - misalnya kesalahan selama penginstalan.

properties.extensionType

string

Jenis Ekstensi, di mana sumber daya ini adalah instans. Ini harus menjadi salah satu Jenis Ekstensi yang terdaftar di Microsoft.KubernetesConfiguration oleh penerbit Ekstensi.

properties.isSystemExtension

boolean

False

Bendera untuk dicatat jika ekstensi ini adalah ekstensi sistem

properties.packageUri

string

Uri paket Helm

properties.provisioningState

ProvisioningState

Status penginstalan ekstensi ini.

properties.releaseTrain

string

Stable

ReleaseTrain ekstensi ini berpartisipasi dalam untuk peningkatan otomatis (misalnya Stabil, Pratinjau, dll.) - hanya jika autoUpgradeMinorVersion adalah 'true'.

properties.scope

Scope

Cakupan tempat ekstensi diinstal.

properties.statuses

ExtensionStatus[]

Status dari ekstensi ini.

properties.version

string

Versi ekstensi yang ditentukan pengguna untuk ekstensi ini ke 'pin'. Untuk menggunakan 'version', autoUpgradeMinorVersion harus 'false'.

systemData

systemData

Metadata tingkat atas https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ExtensionStatus

Status dari ekstensi.

Nama Jenis Nilai default Deskripsi
code

string

Kode status yang disediakan oleh Ekstensi

displayStatus

string

Deskripsi singkat status ekstensi.

level

LevelType

Information

Tingkat status.

message

string

Pesan terperinci tentang status dari Ekstensi.

time

string

DateLiteral (per ISO8601) mencatat waktu status penginstalan.

Identity

Identitas untuk sumber daya.

Nama Jenis Deskripsi
principalId

string

ID utama identitas sumber daya.

tenantId

string

ID penyewa sumber daya.

type

ResourceIdentityType

Jenis identitas.

LevelType

Tingkat status.

Nama Jenis Deskripsi
Error

string

Information

string

Warning

string

Plan

Rencanakan untuk sumber daya.

Nama Jenis Deskripsi
name

string

Nama yang ditentukan pengguna dari Artefak Pihak ke-3 yang sedang diakui.

product

string

Artefak Pihak ke-3 yang sedang diakui. Misalnya NewRelic. Peta produk ke OfferID yang ditentukan untuk artefak pada saat onboarding Data Market.

promotionCode

string

Penerbit memberikan kode promosi sebagaimana disediakan di Pasar Data untuk produk/artefak tersebut.

publisher

string

Penerbit Artefak Pihak ke-3 yang sedang dibeli. Misalnya NewRelic

version

string

Versi produk/artefak yang diinginkan.

ProvisioningState

Status penginstalan ekstensi ini.

Nama Jenis Deskripsi
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

Jenis identitas.

Nama Jenis Deskripsi
SystemAssigned

string

Scope

Cakupan ekstensi. Ini bisa berupa Kluster atau Namespace; tapi tidak keduanya.

Nama Jenis Deskripsi
cluster

ScopeCluster

Menentukan bahwa cakupan ekstensi adalah Kluster

namespace

ScopeNamespace

Menentukan bahwa cakupan ekstensi adalah Namespace

ScopeCluster

Menentukan bahwa cakupan ekstensi adalah Kluster

Nama Jenis Deskripsi
releaseNamespace

string

Namespace tempat Rilis ekstensi harus ditempatkan, untuk ekstensi cakupan Kluster. Jika namespace layanan ini tidak ada, namespace ini akan dibuat

ScopeNamespace

Menentukan bahwa cakupan ekstensi adalah Namespace

Nama Jenis Deskripsi
targetNamespace

string

Namespace tempat ekstensi akan dibuat untuk ekstensi cakupan Namespace. Jika namespace layanan ini tidak ada, namespace ini akan dibuat

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir memodifikasi sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.