@azure/arm-resourcesdeployments package

Interfaces

Alias

Het aliastype.

AliasPath

Het type paden voor alias.

AliasPathMetadata

modelinterface AliasPathMetadata

AliasPattern

Het type van het patroon voor een aliaspad.

ApiProfile

modelinterface ApiProfile

BasicDependency

Informatie over implementatieafhankelijkheid.

CloudError

Een foutbericht voor een aanvraag voor resourcebeheer.

DebugSetting

De instelling voor foutopsporing.

Dependency

Informatie over implementatieafhankelijkheid.

Deployment

Implementatiebewerkingsparameters.

DeploymentDiagnosticsDefinition

modelinterface DeploymentDiagnosticsDefinition

DeploymentExportResult

Het exportresultaat van de implementatie.

DeploymentExtended

Implementatiegegevens.

DeploymentExtensionConfigItem

modelinterface DeploymentExtensionConfigItem

DeploymentExtensionDefinition

modelinterface DeploymentExtensionDefinition

DeploymentExternalInput

Implementatie externe input voor parametrisering.

DeploymentExternalInputDefinition

Implementatie externe invoerdefinitie voor parametrisering.

DeploymentIdentity

De Managed Identity-configuratie voor een implementatie.

DeploymentOperation

Informatie over de implementatiebewerking.

DeploymentOperationProperties

Eigenschappen van de implementatiebewerking.

DeploymentOperationsGetAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentOperationsGetAtScopeOptionalParams

Optionele parameters.

DeploymentOperationsGetAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentOperationsGetAtTenantScopeOptionalParams

Optionele parameters.

DeploymentOperationsGetOptionalParams

Optionele parameters.

DeploymentOperationsListAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentOperationsListAtScopeOptionalParams

Optionele parameters.

DeploymentOperationsListAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentOperationsListAtTenantScopeOptionalParams

Optionele parameters.

DeploymentOperationsListOptionalParams

Optionele parameters.

DeploymentOperationsOperations

Interface die een DeploymentOperations-operatie vertegenwoordigt.

DeploymentParameter

Implementatieparameter voor de sjabloon.

DeploymentProperties

Implementatie-eigenschappen.

DeploymentPropertiesExtended

Implementatie-eigenschappen met aanvullende informatie.

DeploymentValidateResult

Informatie van het antwoord op de implementatie van een sjabloon valideren.

DeploymentWhatIf

Wat-als-bewerkingsparameters implementeren.

DeploymentWhatIfProperties

Wat-als-eigenschappen implementeren.

DeploymentWhatIfSettings

Implementatie What-If bewerkingsinstellingen.

DeploymentsCalculateTemplateHashOptionalParams

Optionele parameters.

DeploymentsCancelAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsCancelAtScopeOptionalParams

Optionele parameters.

DeploymentsCancelAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsCancelAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsCancelOptionalParams

Optionele parameters.

DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsCheckExistenceAtScopeOptionalParams

Optionele parameters.

DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsCheckExistenceAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsCheckExistenceOptionalParams

Optionele parameters.

DeploymentsClientOptionalParams

Optionele parameters voor de client.

DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsCreateOrUpdateAtScopeOptionalParams

Optionele parameters.

DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsCreateOrUpdateAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsCreateOrUpdateOptionalParams

Optionele parameters.

DeploymentsDeleteAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsDeleteAtScopeOptionalParams

Optionele parameters.

DeploymentsDeleteAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsDeleteAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsDeleteOptionalParams

Optionele parameters.

DeploymentsExportTemplateAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsExportTemplateAtScopeOptionalParams

Optionele parameters.

DeploymentsExportTemplateAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsExportTemplateAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsExportTemplateOptionalParams

Optionele parameters.

DeploymentsGetAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsGetAtScopeOptionalParams

Optionele parameters.

DeploymentsGetAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsGetAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsGetOptionalParams

Optionele parameters.

DeploymentsListAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsListAtScopeOptionalParams

Optionele parameters.

DeploymentsListAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsListAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsListByResourceGroupOptionalParams

Optionele parameters.

DeploymentsOperations

Interface die een implementatiebewerkingen vertegenwoordigt.

DeploymentsValidateAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsValidateAtScopeOptionalParams

Optionele parameters.

DeploymentsValidateAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsValidateAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsValidateOptionalParams

Optionele parameters.

DeploymentsWhatIfAtManagementGroupScopeOptionalParams

Optionele parameters.

DeploymentsWhatIfAtSubscriptionScopeOptionalParams

Optionele parameters.

DeploymentsWhatIfAtTenantScopeOptionalParams

Optionele parameters.

DeploymentsWhatIfOptionalParams

Optionele parameters.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactie-indeling.)

ExpressionEvaluationOptions

Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.

ExtensionResource

De bron voor basisextensie.

HttpMessage

HTTP-bericht.

KeyVaultParameterReference

Azure Key Vault-parameterverwijzing.

KeyVaultReference

Naslaginformatie over Azure Key Vault.

OnErrorDeployment

Implementatie bij foutgedrag.

OnErrorDeploymentExtended

Implementatie van foutgedrag met aanvullende informatie.

PageSettings

Opties voor de methode byPage

PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.

ParametersLink

Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.

Provider

Resourceprovidergegevens.

ProviderExtendedLocation

De uitgebreide locatie van de provider.

ProviderResourceType

Resourcetype dat wordt beheerd door de resourceprovider.

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

ResourceReference

Het resource-id-model.

RestorePollerOptions
ScopedDeployment

Implementatiebewerkingsparameters.

ScopedDeploymentWhatIf

Wat-als-bewerkingsparameters implementeren.

SimplePollerLike

Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen.

StatusMessage

Bewerkingsstatusberichtobject.

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TargetResource

Doelresource.

TemplateHashResult

Resultaat van de aanvraag voor het berekenen van sjabloon-hash. Het bevat een tekenreeks met minified sjabloon en de bijbehorende hash.

TemplateLink

Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.

UserAssignedIdentity

Door de gebruiker toegewezen identiteitseigenschappen

WhatIfChange

Informatie over één resourcewijziging die wordt voorspeld door What-If bewerking.

WhatIfOperationProperties

Eigenschappen van de implementatiebewerking.

WhatIfOperationResult

Resultaat van de What-If bewerking. Bevat een lijst met voorspelde wijzigingen en een URL-koppeling om naar de volgende set resultaten te gaan.

WhatIfPropertyChange

De voorspelde wijziging in de resource-eigenschap.

ZoneMapping

modelinterface ZoneMapping

Type-aliassen

AliasPathAttributes

De kenmerken van het token waarnaar het aliaspad verwijst.
KnownAliasPathAttributes kunnen door elkaar worden gebruikt met AliasPathAttributes, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geen: het token waarnaar het aliaspad verwijst, heeft geen kenmerken.
wijzigbare: het token waarnaar het aliaspad verwijst, kan worden gewijzigd door beleid met het effect Wijzigen.

AliasPathTokenType

Het type token waarnaar het aliaspad verwijst.
KnownAliasPathTokenType kan door elkaar worden gebruikt met AliasPathTokenType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NotSpecified: het tokentype is niet opgegeven.
Elk: het tokentype kan van alles zijn.
tekenreeks: het tokentype is tekenreeks.
Object: het tokentype is object.
matrix: het tokentype is matrix.
geheel getal: het tokentype is een geheel getal.
getal: het tokentype is getal.
Booleaanse: het tokentype is booleaanse waarde.

AliasPatternType

Het type aliaspatroon

AliasType

Het type alias.

AzureSupportedClouds

De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype

ChangeType

Het type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd.

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreatedByType

Het type entiteit dat de resource heeft gemaakt.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker: de entiteit is gemaakt door een gebruiker.
application: de entiteit is gemaakt door een toepassing.
ManagedIdentity-: de entiteit is gemaakt door een beheerde identiteit.
Sleutel: de entiteit is gemaakt door een sleutel.

DeploymentIdentityType

Het identiteitstype.
KnownDeploymentIdentityType kan door elkaar worden gebruikt met DeploymentIdentityType, deze enum bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Geen: Geen
GebruikerToegewezen: GebruikerToegewezen

DeploymentMode

De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen.

DeploymentsCheckExistenceAtManagementGroupScopeResponse
DeploymentsCheckExistenceAtScopeResponse
DeploymentsCheckExistenceAtSubscriptionScopeResponse
DeploymentsCheckExistenceAtTenantScopeResponse
DeploymentsCheckExistenceResponse
ExpressionEvaluationOptionsScopeType

Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.
KnownExpressionEvaluationOptionsScopeType kan door elkaar worden gebruikt met ExpressionEvaluationOptionsScopeType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NietGespecificeerd: NietGespecificeerd
Buiten: Buitenkant
Binnen: Binnen.

ExtensionConfigPropertyType

Type van ExtensionConfigPropertyType

Level

Geeft het extra reactieniveau aan.
KnownLevel kan door elkaar worden gebruikt met Niveau, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Waarschuwing: Waarschuwing
Info: Info
Fout: Fout

OnErrorDeploymentType

De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

PropertyChangeType

Het type eigenschapswijziging.

ProviderAuthorizationConsentState

De autorisatiestatus van de provider.
KnownProviderAuthorizationConsentState kan door elkaar worden gebruikt met ProviderAuthorizationConsentState, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NietGespecificeerd: NietGespecificeerd
Vereist: Vereist
NietVereist: NietVereist
Toestemming gegeven: Ingestemd

ProvisioningOperation

De naam van de huidige inrichtingsbewerking.

ProvisioningState

Geeft de status van inrichting aan.
KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

NietGespecificeerd: NietGespecificeerd
Geaccepteerd: Geaccepteerd
Hardlopen: Hardlopen
Klaar: Klaar
Creëren: Creëren
Aangemaakt: Gecreëerd
Verwijderen: Verwijderen
Verwijderd: Verwijderd
Geannuleerd: Geannuleerd
Mislukt: Mislukt
Geslaagd: Geslaagd
Update: Update

ValidationLevel

Het validatieniveau dat is uitgevoerd tijdens de implementatie.
KnownValidationLevel kan door elkaar worden gebruikt met ValidationLevel, deze enum bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Sjabloon: Er wordt een statische analyse van het sjabloon uitgevoerd.
Provider: Er wordt een statische analyse van de sjabloon uitgevoerd en resourcedeclaraties worden verzonden naar resourceproviders voor semantische validatie. Hiermee wordt gecontroleerd of de aanroeper RBAC-schrijfmachtigingen heeft voor elke resource.
ProviderNoRbac: Statische analyse van de sjabloon wordt uitgevoerd en resourcedeclaraties worden verzonden naar resourceproviders voor semantische validatie. Hiermee wordt niet gevalideerd dat de aanroeper RBAC-schrijfmachtigingen heeft voor elke bron.

WhatIfResultFormat

De indeling van de What-If resultaten

Enums

AzureClouds

Een enum om Azure Cloud-omgevingen te beschrijven.

KnownAliasPathAttributes

De kenmerken van het token waarnaar het aliaspad verwijst.

KnownAliasPathTokenType

Het type token waarnaar het aliaspad verwijst.

KnownCreatedByType

Het type entiteit dat de resource heeft gemaakt.

KnownDeploymentIdentityType

Het identiteitstype.

KnownExpressionEvaluationOptionsScopeType

Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.

KnownExtensionConfigPropertyType

Bekende waarden van ExtensionConfigPropertyType die door de service worden geaccepteerd.

KnownLevel

Geeft het extra reactieniveau aan.

KnownProviderAuthorizationConsentState

De autorisatiestatus van de provider.

KnownProvisioningState

Geeft de status van inrichting aan.

KnownValidationLevel

Het validatieniveau dat is uitgevoerd tijdens de implementatie.

KnownVersions

De beschikbare API-versies.

Functies

isRestError(unknown)

Typeguard voor RestError

restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

function restorePoller<TResponse, TResult>(client: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retouren

PollerLike<OperationState<TResult>, TResult>

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type