@azure/arm-resourcesdeployments package
Klasser
| DeploymentsClient |
Gränssnitt
| Alias |
Aliastypen. |
| AliasPath |
Typ av sökvägar för alias. |
| AliasPathMetadata |
modellgränssnitt AliasPathMetadata |
| AliasPattern |
Typ av mönster för en aliassökväg. |
| ApiProfile |
modellgränssnitt ApiProfile |
| BasicDependency |
Information om distributionsberoende. |
| CloudError |
Ett felsvar för en resurshanteringsbegäran. |
| DebugSetting |
Felsökningsinställningen. |
| Dependency |
Information om distributionsberoende. |
| Deployment |
Parametrar för distributionsåtgärd. |
| DeploymentDiagnosticsDefinition |
modellgränssnitt DeploymentDiagnosticsDefinition |
| DeploymentExportResult |
Distributionsexportresultatet. |
| DeploymentExtended |
Distributionsinformation. |
| DeploymentExtensionConfigItem |
modellgränssnitt DeploymentExtensionConfigItem |
| DeploymentExtensionDefinition |
modellgränssnitt DeploymentExtensionDefinition |
| DeploymentExternalInput |
Externa indata för distribution för parametrering. |
| DeploymentExternalInputDefinition |
Definition av externa indata för distribution för parametrisering. |
| DeploymentIdentity |
Konfigurationen av hanterad identitet för en distribution. |
| DeploymentOperation |
Information om distributionsåtgärd. |
| DeploymentOperationProperties |
Egenskaper för distributionsåtgärd. |
| DeploymentOperationsGetAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsGetAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsGetAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsGetAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsGetOptionalParams |
Valfria parametrar. |
| DeploymentOperationsListAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsListAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsListAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsListAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentOperationsListOptionalParams |
Valfria parametrar. |
| DeploymentOperationsOperations |
Gränssnitt som representerar en DeploymentOperations-operation. |
| DeploymentParameter |
Distributionsparameter för mallen. |
| DeploymentProperties |
Distributionsegenskaper. |
| DeploymentPropertiesExtended |
Distributionsegenskaper med ytterligare information. |
| DeploymentValidateResult |
Information från verifiera malldistributionssvaret. |
| DeploymentWhatIf |
Parametrar för konsekvensåtgärder för distribution. |
| DeploymentWhatIfProperties |
Distribution What-if-egenskaper. |
| DeploymentWhatIfSettings |
Distribution What-If åtgärdsinställningar. |
| DeploymentsCalculateTemplateHashOptionalParams |
Valfria parametrar. |
| DeploymentsCancelAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCancelAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCancelAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCancelAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCancelOptionalParams |
Valfria parametrar. |
| DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCheckExistenceAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCheckExistenceAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCheckExistenceOptionalParams |
Valfria parametrar. |
| DeploymentsClientOptionalParams |
Valfria parametrar för klienten. |
| DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCreateOrUpdateAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCreateOrUpdateAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| DeploymentsDeleteAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsDeleteAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsDeleteAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsDeleteAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsDeleteOptionalParams |
Valfria parametrar. |
| DeploymentsExportTemplateAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsExportTemplateAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsExportTemplateAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsExportTemplateAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsExportTemplateOptionalParams |
Valfria parametrar. |
| DeploymentsGetAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsGetAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsGetAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsGetAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsGetOptionalParams |
Valfria parametrar. |
| DeploymentsListAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsListAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsListAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsListAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsListByResourceGroupOptionalParams |
Valfria parametrar. |
| DeploymentsOperations |
Gränssnitt som representerar en distributionsåtgärd. |
| DeploymentsValidateAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsValidateAtScopeOptionalParams |
Valfria parametrar. |
| DeploymentsValidateAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsValidateAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsValidateOptionalParams |
Valfria parametrar. |
| DeploymentsWhatIfAtManagementGroupScopeOptionalParams |
Valfria parametrar. |
| DeploymentsWhatIfAtSubscriptionScopeOptionalParams |
Valfria parametrar. |
| DeploymentsWhatIfAtTenantScopeOptionalParams |
Valfria parametrar. |
| DeploymentsWhatIfOptionalParams |
Valfria parametrar. |
| ErrorAdditionalInfo |
Ytterligare information om resurshanteringsfelet. |
| ErrorResponse |
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.) |
| ExpressionEvaluationOptions |
Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. |
| ExtensionResource |
Den grundläggande tilläggsresursen. |
| HttpMessage |
HTTP-meddelande. |
| KeyVaultParameterReference |
Parameterreferens för Azure Key Vault. |
| KeyVaultReference |
Azure Key Vault-referens. |
| OnErrorDeployment |
Distribution på felbeteende. |
| OnErrorDeploymentExtended |
Distribution av felbeteende med ytterligare information. |
| PageSettings |
Alternativ för byPage-metoden |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| ParametersLink |
Entitet som representerar referensen till distributionsparametrarna. |
| Provider |
Information om resursprovider. |
| ProviderExtendedLocation |
Providerns utökade plats. |
| ProviderResourceType |
Resurstyp som hanteras av resursprovidern. |
| Resource |
Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser |
| ResourceReference |
Resurs-ID-modellen. |
| RestorePollerOptions | |
| ScopedDeployment |
Parametrar för distributionsåtgärd. |
| ScopedDeploymentWhatIf |
Parametrar för konsekvensåtgärder för distribution. |
| SimplePollerLike |
En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd. |
| StatusMessage |
Objekt för åtgärdsstatusmeddelande. |
| SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
| TargetResource |
Målresurs. |
| TemplateHashResult |
Resultatet av begäran om att beräkna mallhash. Den innehåller en sträng med minifierad mall och dess hash. |
| TemplateLink |
Entitet som representerar referensen till mallen. |
| UserAssignedIdentity |
Användartilldelade identitetsegenskaper |
| WhatIfChange |
Information om en enskild resursändring som förutsägs av What-If åtgärd. |
| WhatIfOperationProperties |
Egenskaper för distributionsåtgärd. |
| WhatIfOperationResult |
Resultatet av åtgärden What-If. Innehåller en lista över förutsagda ändringar och en URL-länk för att komma till nästa uppsättning resultat. |
| WhatIfPropertyChange |
Den förutsagda ändringen av resursegenskapen. |
| ZoneMapping |
modellgränssnittet ZoneMapping |
Typalias
| AliasPathAttributes |
Attributen för token som aliassökvägen refererar till. Kända värden som stöds av tjänsten
None: Token som aliassökvägen refererar till har inga attribut. |
| AliasPathTokenType |
Typen av token som aliassökvägen refererar till. Kända värden som stöds av tjänsten
NotSpecified: Tokentypen har inte angetts. |
| AliasPatternType |
Typ av aliasmönster |
| AliasType |
Typ av alias. |
| AzureSupportedClouds |
De värden som stöds för molninställningen som en strängliteraltyp |
| ChangeType |
Typ av ändring som görs i resursen när distributionen körs. |
| ContinuablePage |
Ett gränssnitt som beskriver en resultatsida. |
| CreatedByType |
Den typ av entitet som skapade resursen. Kända värden som stöds av tjänsten
Användare: Entiteten skapades av en användare. |
| DeploymentIdentityType |
Identitetstypen. Kända värden som stöds av tjänsten
Inga: Inga |
| DeploymentMode |
Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser. |
| DeploymentsCheckExistenceAtManagementGroupScopeResponse | |
| DeploymentsCheckExistenceAtScopeResponse | |
| DeploymentsCheckExistenceAtSubscriptionScopeResponse | |
| DeploymentsCheckExistenceAtTenantScopeResponse | |
| DeploymentsCheckExistenceResponse | |
| ExpressionEvaluationOptionsScopeType |
Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall. Kända värden som stöds av tjänsten
InteSpecificerat: InteSpecificerat |
| ExtensionConfigPropertyType |
Type of ExtensionConfigPropertyType |
| Level |
Anger den ytterligare svarsnivån. Kända värden som stöds av tjänsten
Varning: Varning |
| OnErrorDeploymentType |
Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment. |
| PropertyChangeType |
Typ av egenskapsändring. |
| ProviderAuthorizationConsentState |
Tillstånd för providerauktoriseringsmedgivande. Kända värden som stöds av tjänsten
InteSpecificerat: InteSpecificerat |
| ProvisioningOperation |
Namnet på den aktuella etableringsåtgärden. |
| ProvisioningState |
Anger etableringstillståndet. Kända värden som stöds av tjänsten
InteSpecificerat: InteSpecificerat |
| ValidationLevel |
Valideringsnivån som utförs på distributionen. Kända värden som stöds av tjänsten
Mall: Statisk analys av mallen utförs. |
| WhatIfResultFormat |
Formatet på What-If resultat |
Uppräkningar
| AzureClouds |
Ett enum för att beskriva Azure Cloud-miljöer. |
| KnownAliasPathAttributes |
Attributen för token som aliassökvägen refererar till. |
| KnownAliasPathTokenType |
Typen av token som aliassökvägen refererar till. |
| KnownCreatedByType |
Den typ av entitet som skapade resursen. |
| KnownDeploymentIdentityType |
Identitetstypen. |
| KnownExpressionEvaluationOptionsScopeType |
Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall. |
| KnownExtensionConfigPropertyType |
Kända värden för ExtensionConfigPropertyType som tjänsten accepterar. |
| KnownLevel |
Anger den ytterligare svarsnivån. |
| KnownProviderAuthorizationConsentState |
Tillstånd för providerauktoriseringsmedgivande. |
| KnownProvisioningState |
Anger etableringstillståndet. |
| KnownValidationLevel |
Valideringsnivån som utförs på distributionen. |
| KnownVersions |
Tillgängliga API-versioner. |
Funktioner
| is |
Typeguard för RestError |
| restore |
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget. |
Variabler
| Rest |
En anpassad feltyp för misslyckade pipelinebegäranden. |
Funktionsinformation
isRestError(unknown)
Typeguard för RestError
function isRestError(e: unknown): e
Parametrar
- e
-
unknown
Något som fångas av en fångstklausul.
Returer
e
restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.
function restorePoller<TResponse, TResult>(client: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametrar
- client
- DeploymentsClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returer
PollerLike<OperationState<TResult>, TResult>
Variabelinformation
RestError
En anpassad feltyp för misslyckade pipelinebegäranden.
RestError: RestErrorConstructor