@azure/arm-resourcesdeployments package
Klassen
| DeploymentsClient |
Schnittstellen
| Alias |
Der Aliastyp. |
| AliasPath |
Der Typ der Pfade für Alias. |
| AliasPathMetadata |
Modellschnittstelle AliasPathMetadata |
| AliasPattern |
Der Typ des Musters für einen Aliaspfad. |
| ApiProfile |
Modellschnittstelle: ApiProfile |
| BasicDependency |
Informationen zur Bereitstellungsabhängigkeit. |
| CloudError |
Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung. |
| DebugSetting |
Die Debugeinstellung. |
| Dependency |
Informationen zur Bereitstellungsabhängigkeit. |
| Deployment |
Parameter für den Bereitstellungsvorgang. |
| DeploymentDiagnosticsDefinition |
Modellschnittstelle DeploymentDiagnosticsDefinition |
| DeploymentExportResult |
Das Ergebnis des Bereitstellungsexports. |
| DeploymentExtended |
Bereitstellungsinformationen. |
| DeploymentExtensionConfigItem |
Modellschnittstelle DeploymentExtensionConfigItem |
| DeploymentExtensionDefinition |
Modellschnittstelle DeploymentExtensionDefinition |
| DeploymentExternalInput |
Deployment externer Eingang für die Parametrisierung. |
| DeploymentExternalInputDefinition |
Deployment Externe Eingabedefinition für die Parametrisierung. |
| DeploymentIdentity |
Die Konfiguration der verwalteten Identität für eine Bereitstellung. |
| DeploymentOperation |
Informationen zum Bereitstellungsvorgang. |
| DeploymentOperationProperties |
Eigenschaften des Bereitstellungsvorgangs. |
| DeploymentOperationsGetAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsGetAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsGetAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsGetAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsGetOptionalParams |
Optionale Parameter. |
| DeploymentOperationsListAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsListAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsListAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsListAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentOperationsListOptionalParams |
Optionale Parameter. |
| DeploymentOperationsOperations |
Schnittstelle, die eine DeploymentOperations-Operation darstellt. |
| DeploymentParameter |
Bereitstellungsparameter für die Vorlage. |
| DeploymentProperties |
Bereitstellungseigenschaften. |
| DeploymentPropertiesExtended |
Bereitstellungseigenschaften mit zusätzlichen Details. |
| DeploymentValidateResult |
Informationen aus der Antwort auf die Bereitstellung von Vorlagen. |
| DeploymentWhatIf |
Bereitstellungs-Was-wäre-wenn-Vorgangsparameter. |
| DeploymentWhatIfProperties |
Bereitstellungs-Was-wäre-wenn-Eigenschaften. |
| DeploymentWhatIfSettings |
Bereitstellung What-If Vorgangseinstellungen. |
| DeploymentsCalculateTemplateHashOptionalParams |
Optionale Parameter. |
| DeploymentsCancelAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCancelAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCancelAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCancelAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCancelOptionalParams |
Optionale Parameter. |
| DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCheckExistenceAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCheckExistenceAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCheckExistenceOptionalParams |
Optionale Parameter. |
| DeploymentsClientOptionalParams |
Optionale Parameter für den Client. |
| DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCreateOrUpdateAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCreateOrUpdateAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsCreateOrUpdateOptionalParams |
Optionale Parameter. |
| DeploymentsDeleteAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsDeleteAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsDeleteAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsDeleteAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsDeleteOptionalParams |
Optionale Parameter. |
| DeploymentsExportTemplateAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsExportTemplateAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsExportTemplateAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsExportTemplateAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsExportTemplateOptionalParams |
Optionale Parameter. |
| DeploymentsGetAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsGetAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsGetAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsGetAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsGetOptionalParams |
Optionale Parameter. |
| DeploymentsListAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsListAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsListAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsListAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsListByResourceGroupOptionalParams |
Optionale Parameter. |
| DeploymentsOperations |
Schnittstelle, die einen Bereitstellungsvorgang darstellt. |
| DeploymentsValidateAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsValidateAtScopeOptionalParams |
Optionale Parameter. |
| DeploymentsValidateAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsValidateAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsValidateOptionalParams |
Optionale Parameter. |
| DeploymentsWhatIfAtManagementGroupScopeOptionalParams |
Optionale Parameter. |
| DeploymentsWhatIfAtSubscriptionScopeOptionalParams |
Optionale Parameter. |
| DeploymentsWhatIfAtTenantScopeOptionalParams |
Optionale Parameter. |
| DeploymentsWhatIfOptionalParams |
Optionale Parameter. |
| ErrorAdditionalInfo |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
| ErrorResponse |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
| ExpressionEvaluationOptions |
Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden. |
| ExtensionResource |
Die Basiserweiterungsressource. |
| HttpMessage |
HTTP-Nachricht. |
| KeyVaultParameterReference |
Referenz zum Azure Key Vault-Parameter. |
| KeyVaultReference |
Azure Key Vault-Referenz. |
| OnErrorDeployment |
Bereitstellung beim Fehlerverhalten. |
| OnErrorDeploymentExtended |
Bereitstellung bei Fehlerverhalten mit zusätzlichen Details. |
| PageSettings |
Optionen für die byPage-Methode |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| ParametersLink |
Entität, die den Verweis auf die Bereitstellungsparameter darstellt. |
| Provider |
Informationen zum Ressourcenanbieter. |
| ProviderExtendedLocation |
Der erweiterte Anbieterspeicherort. |
| ProviderResourceType |
Vom Ressourcenanbieter verwalteter Ressourcentyp. |
| Resource |
Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden |
| ResourceReference |
Das Ressourcen-ID-Modell. |
| RestorePollerOptions | |
| ScopedDeployment |
Parameter für den Bereitstellungsvorgang. |
| ScopedDeploymentWhatIf |
Bereitstellungs-Was-wäre-wenn-Vorgangsparameter. |
| SimplePollerLike |
Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann. |
| StatusMessage |
Vorgangsstatusmeldungsobjekt. |
| SystemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
| TargetResource |
Zielressource. |
| TemplateHashResult |
Ergebnis der Anforderung zum Berechnen des Vorlagenhashs. Sie enthält eine Zeichenfolge mit minimierter Vorlage und deren Hash. |
| TemplateLink |
Entität, die den Verweis auf die Vorlage darstellt. |
| UserAssignedIdentity |
Benutzer zugewiesene Identitätseigenschaften |
| WhatIfChange |
Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wurde. |
| WhatIfOperationProperties |
Eigenschaften des Bereitstellungsvorgangs. |
| WhatIfOperationResult |
Ergebnis des What-If Vorgangs. Enthält eine Liste der vorhergesagten Änderungen und einen URL-Link, um zum nächsten Satz von Ergebnissen zu gelangen. |
| WhatIfPropertyChange |
Die vorhergesagte Änderung an der Ressourceneigenschaft. |
| ZoneMapping |
Modellschnittstelle: ZoneMapping |
Typaliase
| AliasPathAttributes |
Die Attribute des Tokens, auf das der Aliaspfad verweist. Bekannte Werte, die vom Dienst unterstützt werden
None: Das Token, auf das der Aliaspfad verweist, weist keine Attribute auf. |
| AliasPathTokenType |
Der Typ des Tokens, auf das der Aliaspfad verweist. Bekannte Werte, die vom Dienst unterstützt werden
NotSpecified: Der Tokentyp ist nicht angegeben. |
| AliasPatternType |
Der Typ des Aliasmusters |
| AliasType |
Der Typ des Alias. |
| AzureSupportedClouds |
Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp |
| ChangeType |
Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird. |
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
| CreatedByType |
Die Art der Entität, die die Ressource erstellt hat. Bekannte Werte, die vom Dienst unterstützt werden
Benutzer-: Die Entität wurde von einem Benutzer erstellt. |
| DeploymentIdentityType |
Der Identitätstyp. Bekannte Werte, die vom Dienst unterstützt werden
Keine: Keine |
| DeploymentMode |
Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen. |
| DeploymentsCheckExistenceAtManagementGroupScopeResponse | |
| DeploymentsCheckExistenceAtScopeResponse | |
| DeploymentsCheckExistenceAtSubscriptionScopeResponse | |
| DeploymentsCheckExistenceAtTenantScopeResponse | |
| DeploymentsCheckExistenceResponse | |
| ExpressionEvaluationOptionsScopeType |
Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer verschachtelten Vorlage verwendet werden soll. Bekannte Werte, die vom Dienst unterstützt werden
Nicht Spezifiziert: Nicht Spezifiziert |
| ExtensionConfigPropertyType |
Typ von ExtensionConfigPropertyType |
| Level |
Gibt die zusätzliche Antwortebene an. Bekannte Werte, die vom Dienst unterstützt werden
Warnung: Warnung |
| OnErrorDeploymentType |
Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. |
| PropertyChangeType |
Der Typ der Eigenschaftsänderung. |
| ProviderAuthorizationConsentState |
Der Autorisierungsstatus des Anbieters. Bekannte Werte, die vom Dienst unterstützt werden
Nicht Spezifiziert: Nicht Spezifiziert |
| ProvisioningOperation |
Der Name des aktuellen Bereitstellungsvorgangs. |
| ProvisioningState |
Gibt den Bereitstellungsstatus an. Bekannte Werte, die vom Dienst unterstützt werden
Nicht Spezifiziert: Nicht Spezifiziert |
| ValidationLevel |
Die Validierungsebene, die für die Bereitstellung ausgeführt wurde. Bekannte Werte, die vom Dienst unterstützt werden
Vorlage: Die statische Analyse der Vorlage wird durchgeführt. |
| WhatIfResultFormat |
Das Format der What-If Ergebnisse |
Enumerationen
| AzureClouds |
Ein Enum zur Beschreibung von Azure Cloud-Umgebungen. |
| KnownAliasPathAttributes |
Die Attribute des Tokens, auf das der Aliaspfad verweist. |
| KnownAliasPathTokenType |
Der Typ des Tokens, auf das der Aliaspfad verweist. |
| KnownCreatedByType |
Die Art der Entität, die die Ressource erstellt hat. |
| KnownDeploymentIdentityType |
Der Identitätstyp. |
| KnownExpressionEvaluationOptionsScopeType |
Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer verschachtelten Vorlage verwendet werden soll. |
| KnownExtensionConfigPropertyType |
Bekannte Werte von ExtensionConfigPropertyType , die der Dienst akzeptiert. |
| KnownLevel |
Gibt die zusätzliche Antwortebene an. |
| KnownProviderAuthorizationConsentState |
Der Autorisierungsstatus des Anbieters. |
| KnownProvisioningState |
Gibt den Bereitstellungsstatus an. |
| KnownValidationLevel |
Die Validierungsebene, die für die Bereitstellung ausgeführt wurde. |
| KnownVersions |
Die verfügbaren API-Versionen. |
Functions
| is |
Typeguard für RestError |
| restore |
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt. |
Variablen
| Rest |
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen. |
Details zur Funktion
isRestError(unknown)
Typeguard für RestError
function isRestError(e: unknown): e
Parameter
- e
-
unknown
Etwas, das von einer Catch-Klausel abgefangen wird.
Gibt zurück
e
restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.
function restorePoller<TResponse, TResult>(client: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameter
- client
- DeploymentsClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Gibt zurück
PollerLike<OperationState<TResult>, TResult>
Details zu Variablen
RestError
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
RestError: RestErrorConstructor