Maintenance Configurations - Get

Odwołanie

Service:: AKS

API Version:: 2023-07-01

Pobiera określoną konfigurację konserwacji klastra zarządzanego.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}?api-version=2023-07-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
configName	path	True	string	Nazwa konfiguracji konserwacji.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
resourceName	path	True	string	Nazwa zasobu klastra zarządzanego. Regex pattern: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MaintenanceConfiguration	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get Maintenance Configuration

Get Maintenance Configuration Configured With Maintenance Window

Get Maintenance Configuration

Sample Request

GET https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default?api-version=2023-07-01

/** Samples for MaintenanceConfigurations Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json
     */
    /**
     * Sample code: Get Maintenance Configuration.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getMaintenanceConfiguration(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .kubernetesClusters()
            .manager()
            .serviceClient()
            .getMaintenanceConfigurations()
            .getWithResponse("rg1", "clustername1", "default", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python maintenance_configurations_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid1",
    )

    response = client.maintenance_configurations.get(
        resource_group_name="rg1",
        resource_name="clustername1",
        config_name="default",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified maintenance configuration of a managed cluster.
 *
 * @summary Gets the specified maintenance configuration of a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet.json
 */
async function getMaintenanceConfiguration() {
  const subscriptionId = process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "subid1";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const configName = "default";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.maintenanceConfigurations.get(
    resourceGroupName,
    resourceName,
    configName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
  "name": "default",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "timeInWeek": [
      {
        "day": "Monday",
        "hourSlots": [
          1,
          2
        ]
      }
    ],
    "notAllowedTime": [
      {
        "start": "2020-11-26T03:00:00Z",
        "end": "2020-11-30T12:00:00Z"
      }
    ]
  }
}

Get Maintenance Configuration Configured With Maintenance Window

Sample Request

GET https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule?api-version=2023-07-01

/** Samples for MaintenanceConfigurations Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json
     */
    /**
     * Sample code: Get Maintenance Configuration Configured With Maintenance Window.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getMaintenanceConfigurationConfiguredWithMaintenanceWindow(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .kubernetesClusters()
            .manager()
            .serviceClient()
            .getMaintenanceConfigurations()
            .getWithResponse(
                "rg1", "clustername1", "aksManagedNodeOSUpgradeSchedule", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python maintenance_configurations_get_maintenance_window.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid1",
    )

    response = client.maintenance_configurations.get(
        resource_group_name="rg1",
        resource_name="clustername1",
        config_name="aksManagedNodeOSUpgradeSchedule",
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified maintenance configuration of a managed cluster.
 *
 * @summary Gets the specified maintenance configuration of a managed cluster.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2023-07-01/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json
 */
async function getMaintenanceConfigurationConfiguredWithMaintenanceWindow() {
  const subscriptionId = process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "subid1";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const configName = "aksManagedNodeOSUpgradeSchedule";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const result = await client.maintenanceConfigurations.get(
    resourceGroupName,
    resourceName,
    configName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/aksManagedNodeOSUpgradeSchedule",
  "name": "aksManagedNodeOSUpgradeSchedule",
  "properties": {
    "maintenanceWindow": {
      "schedule": {
        "daily": {
          "intervalDays": 3
        }
      },
      "durationHours": 4,
      "utcOffset": "-07:00",
      "startDate": "2023-01-01",
      "startTime": "09:30",
      "notAllowedDates": [
        {
          "start": "2023-02-18",
          "end": "2023-02-25"
        },
        {
          "start": "2023-12-23",
          "end": "2024-01-05"
        }
      ]
    }
  }
}

Definicje

Nazwa	Opis
AbsoluteMonthlySchedule	W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc na 15" lub "powtarzaj co 3 miesiące w dniu 20".
CloudError	Odpowiedź o błędzie z usługi Container Service.
CloudErrorBody	Odpowiedź o błędzie z usługi Container Service.
createdByType	Typ tożsamości, która utworzyła zasób.
DailySchedule	W przypadku harmonogramów, takich jak: "powtarzaj codziennie" lub "powtarzaj się co 3 dni".
DateSpan	Zakres dat.
MaintenanceConfiguration	Konfiguracja planowanej konserwacji używana do konfigurowania, kiedy aktualizacje można wdrożyć w klastrze zarządzanym.
MaintenanceWindow	Okno obsługi używane do konfigurowania zaplanowanego automatycznego uaktualniania klastra zarządzanego.
RelativeMonthlySchedule	W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc w pierwszy poniedziałek" lub "powtarzaj co 3 miesiące w ostatni piątek".
Schedule	Należy określić jeden i tylko jeden z typów harmonogramu. Wybierz opcję "daily", "weekly", "absoluteMonthly" lub "relativeMonthly" dla harmonogramu konserwacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TimeInWeek	Czas w tygodniu.
TimeSpan	Zakres czasu.
type	Indeks tygodnia.
WeekDay	Wyliczenie dnia tygodnia.
WeeklySchedule	W przypadku harmonogramów, takich jak: "powtarzaj się co poniedziałek" lub "powtarzaj co 3 tygodnie w środę".

AbsoluteMonthlySchedule

W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc na 15" lub "powtarzaj co 3 miesiące w dniu 20".

Nazwa	Typ	Opis
dayOfMonth	integer	Data miesiąca.
intervalMonths	integer	Określa liczbę miesięcy między każdym zestawem wystąpień.

CloudError

Odpowiedź o błędzie z usługi Container Service.

Nazwa	Typ	Opis
error	CloudErrorBody	Szczegóły dotyczące błędu.

CloudErrorBody

Odpowiedź o błędzie z usługi Container Service.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DailySchedule

W przypadku harmonogramów, takich jak: "powtarzaj codziennie" lub "powtarzaj się co 3 dni".

Nazwa	Typ	Opis
intervalDays	integer	Określa liczbę dni między poszczególnymi zestawami wystąpień.

DateSpan

Zakres dat.

Nazwa	Typ	Opis
end	string	Data zakończenia zakresu dat.
start	string	Data rozpoczęcia zakresu dat.

MaintenanceConfiguration

Konfiguracja planowanej konserwacji używana do konfigurowania, kiedy aktualizacje można wdrożyć w klastrze zarządzanym.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.
properties.maintenanceWindow	MaintenanceWindow	Okno obsługi konfiguracji konserwacji.
properties.notAllowedTime	TimeSpan[]	Przedziały czasu, w których uaktualnienie jest niedozwolone.
properties.timeInWeek	TimeInWeek[]	Przedziały czasu w tygodniu, w których planowana konserwacja może kontynuować. Jeśli dwa wpisy tablicy określają ten sam dzień tygodnia, zastosowana konfiguracja jest związkiem razy w obu wpisach.
systemData	systemData	Metadane systemowe dotyczące tego zasobu.
type	string	Typ zasobu

MaintenanceWindow

Okno obsługi używane do konfigurowania zaplanowanego automatycznego uaktualniania klastra zarządzanego.

Nazwa	Typ	Wartość domyślna	Opis
durationHours	integer	24	Długość okna obsługi wynosi od 4 do 24 godzin.
notAllowedDates	DateSpan[]		Zakresy dat, w których uaktualnienie jest niedozwolone. Pole "utcOffset" ma zastosowanie do tego pola. Na przykład z wartością "utcOffset: +02:00" i "dateSpan" to "2022-12-23" do "2023-01-03", konserwacja zostanie zablokowana od "2022-12-22 22:00" do "2023-01-03 22:00" w czasie UTC.
schedule	Schedule		Harmonogram cyklu okna obsługi.
startDate	string		Data aktywowania okna obsługi. Jeśli bieżąca data przypada przed tą datą, okno obsługi jest nieaktywne i nie będzie używane do uaktualniania. Jeśli nie zostanie określony, okno obsługi będzie aktywne od razu.
startTime	string		Godzina rozpoczęcia okna obsługi. Akceptowane wartości pochodzą od "00:00" do "23:59". Pole "utcOffset" ma zastosowanie do tego pola. Na przykład: "02:00" z "utcOffset: +02:00" oznacza czas UTC "00:00".
utcOffset	string		Przesunięcie UTC w formacie +/-HH:mm. Na przykład "+05:30" dla IST i "-07:00" dla pst. Jeśli nie zostanie określony, wartość domyślna to "+00:00".

RelativeMonthlySchedule

W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc w pierwszy poniedziałek" lub "powtarzaj co 3 miesiące w ostatni piątek".

Nazwa	Typ	Opis
dayOfWeek	WeekDay	Określa, w którym dniu tygodnia następuje konserwacja.
intervalMonths	integer	Określa liczbę miesięcy między każdym zestawem wystąpień.
weekIndex	type	Indeks tygodnia. Określa, w którym tygodniu miesiąca ma zastosowanie dzieńOfWeek.

Schedule

Należy określić jeden i tylko jeden z typów harmonogramu. Wybierz opcję "daily", "weekly", "absoluteMonthly" lub "relativeMonthly" dla harmonogramu konserwacji.

Nazwa	Typ	Opis
absoluteMonthly	AbsoluteMonthlySchedule	W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc na 15" lub "powtarzaj co 3 miesiące w dniu 20".
daily	DailySchedule	W przypadku harmonogramów, takich jak: "powtarzaj codziennie" lub "powtarzaj się co 3 dni".
relativeMonthly	RelativeMonthlySchedule	W przypadku harmonogramów, takich jak: "powtarzaj co miesiąc w pierwszy poniedziałek" lub "powtarzaj co 3 miesiące w ostatni piątek".
weekly	WeeklySchedule	W przypadku harmonogramów, takich jak: "powtarzaj się co poniedziałek" lub "powtarzaj co 3 tygodnie w środę".

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TimeInWeek

Czas w tygodniu.

Nazwa	Typ	Opis
day	WeekDay	Dzień tygodnia.
hourSlots	integer[]	Lista godzin w ciągu dnia używana do identyfikowania zakresu czasu. Każda godzina całkowita reprezentuje zakres czasu rozpoczynający się od 0 m po godzinie kończącej się na następnej godzinie (bez włącznie). 0 odpowiada 00:00 UTC, 23 odpowiada 23:00 UTC. Określenie [0, 1] oznacza zakres czasu 00:00–02:00 UTC.

TimeSpan

Zakres czasu.

Nazwa	Typ	Opis
end	string	Koniec przedziału czasu
start	string	Początek przedziału czasu

type

Indeks tygodnia.

Nazwa	Typ	Opis
First	string	Pierwszy tydzień miesiąca.
Fourth	string	Czwarty tydzień miesiąca.
Last	string	W zeszłym tygodniu miesiąca.
Second	string	Drugi tydzień miesiąca.
Third	string	Trzeci tydzień miesiąca.

WeekDay

Wyliczenie dnia tygodnia.

Nazwa	Typ	Opis
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

WeeklySchedule

W przypadku harmonogramów, takich jak: "powtarzaj się co poniedziałek" lub "powtarzaj co 3 tygodnie w środę".

Nazwa	Typ	Opis
dayOfWeek	WeekDay	Określa, w którym dniu tygodnia następuje konserwacja.
intervalWeeks	integer	Określa liczbę tygodni między każdym zestawem wystąpień.

Maintenance Configurations - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Get Maintenance Configuration

Sample Request

Sample Response

Get Maintenance Configuration Configured With Maintenance Window

Sample Request

Sample Response

Definicje

AbsoluteMonthlySchedule

CloudError

CloudErrorBody

createdByType

DailySchedule

DateSpan

MaintenanceConfiguration

MaintenanceWindow

RelativeMonthlySchedule

Schedule

systemData

TimeInWeek

TimeSpan

type

WeekDay

WeeklySchedule

Dodatkowe zasoby