Compartilhar via

@azure/arm-containerservicefleet package

  • Referência

Classes

ContainerServiceFleetClient

Interfaces

APIServerAccessProfile

Perfil de acesso para o servidor de API do Hub fleet.
AgentProfile

Perfil do agente para o Hub da Frota.
ContainerServiceFleetClientOptionalParams

Parâmetros opcionais.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
Fleet

O recurso Fleet.
FleetCredentialResult

Um item de resultado de credencial.
FleetCredentialResults

A resposta dos resultados da credencial.
FleetHubProfile

O FleetHubProfile configura o hub de frota.
FleetListResult

A resposta de uma operação de lista da Frota.
FleetMember

Um membro da Frota. Ele contém uma referência a um cluster kubernetes existente no Azure.
FleetMemberListResult

A resposta de uma operação de lista FleetMember.
FleetMemberUpdate

O tipo usado para operações de atualização do FleetMember.
FleetMembers

Interface que representa um FleetMembers.
FleetMembersCreateHeaders

Define cabeçalhos para FleetMembers_create operação.
FleetMembersCreateOptionalParams

Parâmetros opcionais.
FleetMembersDeleteHeaders

Define cabeçalhos para FleetMembers_delete operação.
FleetMembersDeleteOptionalParams

Parâmetros opcionais.
FleetMembersGetOptionalParams

Parâmetros opcionais.
FleetMembersListByFleetNextOptionalParams

Parâmetros opcionais.
FleetMembersListByFleetOptionalParams

Parâmetros opcionais.
FleetMembersUpdateHeaders

Define cabeçalhos para FleetMembers_update operação.
FleetMembersUpdateOptionalParams

Parâmetros opcionais.
FleetPatch

Propriedades de uma Frota que pode ser corrigida.
FleetUpdateStrategies

Interface que representa um FleetUpdateStrategies.
FleetUpdateStrategiesCreateOrUpdateHeaders

Define cabeçalhos para FleetUpdateStrategies_createOrUpdate operação.
FleetUpdateStrategiesCreateOrUpdateOptionalParams

Parâmetros opcionais.
FleetUpdateStrategiesDeleteHeaders

Define cabeçalhos para FleetUpdateStrategies_delete operação.
FleetUpdateStrategiesDeleteOptionalParams

Parâmetros opcionais.
FleetUpdateStrategiesGetOptionalParams

Parâmetros opcionais.
FleetUpdateStrategiesListByFleetNextOptionalParams

Parâmetros opcionais.
FleetUpdateStrategiesListByFleetOptionalParams

Parâmetros opcionais.
FleetUpdateStrategy

Define um processo de vários estágios para executar operações de atualização entre membros de uma Frota.
FleetUpdateStrategyListResult

A resposta de uma operação de lista FleetUpdateStrategy.
Fleets

Interface que representa um Fleets.
FleetsCreateOrUpdateHeaders

Define cabeçalhos para Fleets_createOrUpdate operação.
FleetsCreateOrUpdateOptionalParams

Parâmetros opcionais.
FleetsDeleteHeaders

Define cabeçalhos para Fleets_delete operação.
FleetsDeleteOptionalParams

Parâmetros opcionais.
FleetsGetOptionalParams

Parâmetros opcionais.
FleetsListByResourceGroupNextOptionalParams

Parâmetros opcionais.
FleetsListByResourceGroupOptionalParams

Parâmetros opcionais.
FleetsListBySubscriptionNextOptionalParams

Parâmetros opcionais.
FleetsListBySubscriptionOptionalParams

Parâmetros opcionais.
FleetsListCredentialsOptionalParams

Parâmetros opcionais.
FleetsUpdateHeaders

Define cabeçalhos para Fleets_update operação.
FleetsUpdateOptionalParams

Parâmetros opcionais.
ManagedClusterUpdate

A atualização a ser aplicada aos ManagedClusters.
ManagedClusterUpgradeSpec

A atualização a ser aplicada a um ManagedCluster.
ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
MemberUpdateStatus

O status de uma operação de atualização de membro.
NodeImageSelection

A atualização de imagem do nó a ser aplicada aos nós de destino na execução da atualização.
NodeImageSelectionStatus

As especificações de atualização de imagem do nó para a execução da atualização.
NodeImageVersion

A versão da imagem de atualização do nó.
Operation

Detalhes de uma operação de API REST, retornada da API de Operações do Provedor de Recursos
OperationDisplay

Informações de exibição localizadas para esta operação específica.
OperationListResult

Uma lista de operações da API REST com suporte por um Provedor de Recursos do Azure. Ele contém um link de URL para obter o próximo conjunto de resultados.
Operations

Interface que representa uma operação.
OperationsListNextOptionalParams

Parâmetros opcionais.
OperationsListOptionalParams

Parâmetros opcionais.
ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local
Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager
SkipProperties

As propriedades de uma operação de ignorar que contém várias solicitações de ignorar.
SkipTarget

A definição de uma única solicitação de ignorar.
SystemData

Metadados relativos à criação e última modificação do recurso.
TrackedResource

A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'
UpdateGroup

Um grupo a ser atualizado.
UpdateGroupStatus

O status de um UpdateGroup.
UpdateRun

Um processo de vários estágios para executar operações de atualização entre membros de uma Frota.
UpdateRunListResult

A resposta de uma operação de lista UpdateRun.
UpdateRunStatus

O status de um UpdateRun.
UpdateRunStrategy

Define a sequência de atualização dos clusters por meio de estágios e grupos.

Estágios dentro de uma execução são executados sequencialmente um após o outro. Os grupos em um estágio são executados em paralelo. Os clusters de membro em um grupo são atualizados sequencialmente um após o outro.

Uma estratégia válida não contém grupos duplicados dentro ou entre estágios.
UpdateRuns

Interface que representa um UpdateRuns.
UpdateRunsCreateOrUpdateHeaders

Define cabeçalhos para UpdateRuns_createOrUpdate operação.
UpdateRunsCreateOrUpdateOptionalParams

Parâmetros opcionais.
UpdateRunsDeleteHeaders

Define cabeçalhos para UpdateRuns_delete operação.
UpdateRunsDeleteOptionalParams

Parâmetros opcionais.
UpdateRunsGetOptionalParams

Parâmetros opcionais.
UpdateRunsListByFleetNextOptionalParams

Parâmetros opcionais.
UpdateRunsListByFleetOptionalParams

Parâmetros opcionais.
UpdateRunsSkipHeaders

Define cabeçalhos para UpdateRuns_skip operação.
UpdateRunsSkipOptionalParams

Parâmetros opcionais.
UpdateRunsStartHeaders

Define cabeçalhos para UpdateRuns_start operação.
UpdateRunsStartOptionalParams

Parâmetros opcionais.
UpdateRunsStopHeaders

Define cabeçalhos para UpdateRuns_stop operação.
UpdateRunsStopOptionalParams

Parâmetros opcionais.
UpdateStage

Define um estágio que contém os grupos a serem atualizados e as etapas a serem tomadas (por exemplo, aguarde um período de tempo) antes de iniciar o próximo estágio.
UpdateStageStatus

O status de um UpdateStage.
UpdateStatus

O status de uma operação ou grupo de operações.
UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário
WaitStatus

O status da duração da espera.

Aliases de tipo

ActionType

Define valores para ActionType.
KnownActionType pode ser usado de forma intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Interna
CreatedByType

Define valores para CreatedByType.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de usuário do
application
ManagedIdentity
key
FleetMemberProvisioningState

Define valores para FleetMemberProvisioningState.
KnownFleetMemberProvisioningState pode ser usado de forma intercambiável com FleetMemberProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: o recurso foi criado.
falha no: falha na criação de recursos.
cancelou: a criação de recursos foi cancelada.
ingressar em: o estado de provisionamento de um membro que ingressa em uma frota.
deixando: o estado de provisionamento de um membro saindo de uma frota.
Atualizando: o estado de provisionamento de um membro que está sendo atualizado.
FleetMembersCreateResponse

Contém dados de resposta para a operação de criação.
FleetMembersGetResponse

Contém dados de resposta para a operação de obtenção.
FleetMembersListByFleetNextResponse

Contém dados de resposta para a operação listByFleetNext.
FleetMembersListByFleetResponse

Contém dados de resposta para a operação listByFleet.
FleetMembersUpdateResponse

Contém dados de resposta para a operação de atualização.
FleetProvisioningState

Define valores para FleetProvisioningState.
KnownFleetProvisioningState podem ser usados de forma intercambiável com FleetProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: o recurso foi criado.
falha no: falha na criação de recursos.
cancelou: a criação de recursos foi cancelada.
Criando: o estado de provisionamento de uma frota que está sendo criada.
Atualizando: o estado de provisionamento de uma frota que está sendo atualizada.
excluindo: o estado de provisionamento de uma frota que está sendo excluída.
FleetUpdateStrategiesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
FleetUpdateStrategiesGetResponse

Contém dados de resposta para a operação de obtenção.
FleetUpdateStrategiesListByFleetNextResponse

Contém dados de resposta para a operação listByFleetNext.
FleetUpdateStrategiesListByFleetResponse

Contém dados de resposta para a operação listByFleet.
FleetUpdateStrategyProvisioningState

Define valores para FleetUpdateStrategyProvisioningState.
KnownFleetUpdateStrategyProvisioningState pode ser usado de forma intercambiável com FleetUpdateStrategyProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: o recurso foi criado.
falha no: falha na criação de recursos.
cancelou: a criação de recursos foi cancelada.
FleetsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
FleetsGetResponse

Contém dados de resposta para a operação de obtenção.
FleetsListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.
FleetsListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.
FleetsListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.
FleetsListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.
FleetsListCredentialsResponse

Contém dados de resposta para a operação listCredentials.
FleetsUpdateResponse

Contém dados de resposta para a operação de atualização.
ManagedClusterUpgradeType

Define valores para ManagedClusterUpgradeType.
KnownManagedClusterUpgradeType pode ser usado de forma intercambiável com ManagedClusterUpgradeType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Completo: atualiza o plano de controle completo e todos os pools de agentes dos ManagedClusters de destino. Requer que a propriedade ManagedClusterUpgradeSpec.KubernetesVersion seja definida.
NodeImageOnly: NodeImageOnly atualiza apenas as imagens de nó dos ManagedClusters de destino. Requer que a propriedade ManagedClusterUpgradeSpec.KubernetesVersion NÃO seja definida.
ControlPlaneOnly: o ControlPlaneOnly atualiza apenas o KubernetesVersion dos ManagedClusters e não será aplicado ao AgentPool. Requer que a propriedade ManagedClusterUpgradeSpec.KubernetesVersion seja definida.
ManagedServiceIdentityType

Define valores para ManagedServiceIdentityType.
KnownManagedServiceIdentityType pode ser usado de forma intercambiável com ManagedServiceIdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhum
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
NodeImageSelectionType

Define valores para NodeImageSelectionType.
KnownNodeImageSelectionType pode ser usado de forma intercambiável com NodeImageSelectionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

última: use a versão mais recente da imagem ao atualizar nós. Os clusters podem usar versões de imagem diferentes (por exemplo, 'AKSUbuntu-1804gen2containerd-2021.10.12' e 'AKSUbuntu-1804gen2containerd-2021.10.19') porque, por exemplo, a versão mais recente disponível é diferente em regiões diferentes.
consistente: as versões de imagem para atualizar nós são selecionadas conforme descrito abaixo: para cada pool de nós em clusters gerenciados afetados pela execução da atualização, o sistema seleciona a versão de imagem mais recente, de modo que ela esteja disponível em todos os outros pools de nós (em todos os outros clusters) do mesmo tipo de imagem. Como resultado, todos os pools de nós do mesmo tipo de imagem serão atualizados para a mesma versão de imagem. Por exemplo, se a versão de imagem mais recente do tipo de imagem 'AKSUbuntu-1804gen2containerd' for 'AKSUbuntu-1804gen2containerd-2021.10.12' para um pool de nós no cluster A na região X, e é 'AKSUbuntu-1804gen2containerd-2021.10.17' para um pool de nós no cluster B na região Y, o sistema atualizará os dois pools de nós para a versão de imagem 'AKSUbuntu-1804gen2containerd-2021.10.12'.
OperationsListNextResponse

Contém dados de resposta para a operação listNext.
OperationsListResponse

Contém dados de resposta para a operação de lista.
Origin

Define valores de Origem.
KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

usuário
sistema
usuário, do sistema
TargetType

Define valores para TargetType.
KnownTargetType pode ser usado de forma intercambiável com TargetType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Membro: ignore a atualização de um membro.
Group: ignore a atualização de um grupo.
Stage: ignore a atualização de um estágio inteiro, incluindo a espera após o estágio.
AfterStageWait: ignore a atualização da espera após o estágio de um determinado estágio.
UpdateRunProvisioningState

Define valores para UpdateRunProvisioningState.
KnownUpdateRunProvisioningState pode ser usado de forma intercambiável com UpdateRunProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: o recurso foi criado.
falha no: falha na criação de recursos.
cancelou: a criação de recursos foi cancelada.
UpdateRunsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.
UpdateRunsGetResponse

Contém dados de resposta para a operação de obtenção.
UpdateRunsListByFleetNextResponse

Contém dados de resposta para a operação listByFleetNext.
UpdateRunsListByFleetResponse

Contém dados de resposta para a operação listByFleet.
UpdateRunsSkipResponse

Contém dados de resposta para a operação de ignorar.
UpdateRunsStartResponse

Contém dados de resposta para a operação de início.
UpdateRunsStopResponse

Contém dados de resposta para a operação de parada.
UpdateState

Define valores para UpdateState.
KnownUpdateState pode ser usado de forma intercambiável com UpdateState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

NotStarted: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate que não foi iniciado.
Executando: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate em execução.
Parar: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate que está sendo interrompido.
Parado: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate que foi interrompido.
Ignorado: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate que foi ignorado.
falha: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate que falhou.
Concluído: o estado de um UpdateRun/UpdateStage/UpdateGroup/MemberUpdate concluído.

Enumerações

KnownActionType

Valores conhecidos de ActionType que o serviço aceita.
KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.
KnownFleetMemberProvisioningState

Valores conhecidos de FleetMemberProvisioningState que o serviço aceita.
KnownFleetProvisioningState

Valores conhecidos de FleetProvisioningState que o serviço aceita.
KnownFleetUpdateStrategyProvisioningState

Valores conhecidos de FleetUpdateStrategyProvisioningState que o serviço aceita.
KnownManagedClusterUpgradeType

Valores conhecidos de ManagedClusterUpgradeType que o serviço aceita.
KnownManagedServiceIdentityType

Valores conhecidos de ManagedServiceIdentityType que o serviço aceita.
KnownNodeImageSelectionType

Valores conhecidos de NodeImageSelectionType que o serviço aceita.
KnownOrigin

Valores conhecidos de Origin que o serviço aceita.
KnownTargetType

Valores conhecidos de TargetType que o serviço aceita.
KnownUpdateRunProvisioningState

Valores conhecidos de UpdateRunProvisioningState que o serviço aceita.
KnownUpdateState

Valores conhecidos de UpdateState que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador de byPage.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.