@azure/arm-resourcesdeployments package
Classes
| DeploymentsClient |
Interfaces
| Alias |
Type d’alias. |
| AliasPath |
Type des chemins d’accès pour l’alias. |
| AliasPathMetadata |
interface de modèle AliasPathMetadata |
| AliasPattern |
Type du modèle pour un chemin d’alias. |
| ApiProfile |
interface modèle ApiProfile |
| BasicDependency |
Informations sur les dépendances de déploiement. |
| CloudError |
Réponse d’erreur pour une demande de gestion des ressources. |
| DebugSetting |
Paramètre de débogage. |
| Dependency |
Informations sur les dépendances de déploiement. |
| Deployment |
Paramètres d’opération de déploiement. |
| DeploymentDiagnosticsDefinition |
interface de modèle DéploiementDiagnosticsDéfinition |
| DeploymentExportResult |
Résultat de l’exportation de déploiement. |
| DeploymentExtended |
Informations de déploiement. |
| DeploymentExtensionConfigItem |
Interface de modèle DeploymentExtensionConfigItem |
| DeploymentExtensionDefinition |
interface de modèle DéploiementExtensionDéfinition |
| DeploymentExternalInput |
Entrée externe de déploiement pour le paramétrage. |
| DeploymentExternalInputDefinition |
Définition de l’entrée externe de déploiement pour le paramétrage. |
| DeploymentIdentity |
Configuration de l’identité managée pour un déploiement. |
| DeploymentOperation |
Informations sur l’opération de déploiement. |
| DeploymentOperationProperties |
Propriétés de l’opération de déploiement. |
| DeploymentOperationsGetAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsGetAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsGetAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsGetAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsGetOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsListAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsListAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsListAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsListAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsListOptionalParams |
Paramètres facultatifs. |
| DeploymentOperationsOperations |
Interface représentant une opération DeploymentOperations. |
| DeploymentParameter |
Paramètre de déploiement pour le modèle. |
| DeploymentProperties |
Propriétés de déploiement. |
| DeploymentPropertiesExtended |
Propriétés de déploiement avec des détails supplémentaires. |
| DeploymentValidateResult |
Informations de validation de la réponse de déploiement du modèle. |
| DeploymentWhatIf |
Paramètres d’opération de simulation de déploiement. |
| DeploymentWhatIfProperties |
Propriétés de scénario de déploiement. |
| DeploymentWhatIfSettings |
Paramètres d’opération de déploiement What-If. |
| DeploymentsCalculateTemplateHashOptionalParams |
Paramètres facultatifs. |
| DeploymentsCancelAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCancelAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCancelAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCancelAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCancelOptionalParams |
Paramètres facultatifs. |
| DeploymentsCheckExistenceAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCheckExistenceAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCheckExistenceAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCheckExistenceAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCheckExistenceOptionalParams |
Paramètres facultatifs. |
| DeploymentsClientOptionalParams |
Paramètres facultatifs pour le client. |
| DeploymentsCreateOrUpdateAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCreateOrUpdateAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCreateOrUpdateAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCreateOrUpdateAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| DeploymentsDeleteAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsDeleteAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsDeleteAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsDeleteAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsDeleteOptionalParams |
Paramètres facultatifs. |
| DeploymentsExportTemplateAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsExportTemplateAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsExportTemplateAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsExportTemplateAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsExportTemplateOptionalParams |
Paramètres facultatifs. |
| DeploymentsGetAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsGetAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsGetAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsGetAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsGetOptionalParams |
Paramètres facultatifs. |
| DeploymentsListAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsListAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsListAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsListAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| DeploymentsOperations |
Interface représentant une opération de déploiement. |
| DeploymentsValidateAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsValidateAtScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsValidateAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsValidateAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsValidateOptionalParams |
Paramètres facultatifs. |
| DeploymentsWhatIfAtManagementGroupScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsWhatIfAtSubscriptionScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsWhatIfAtTenantScopeOptionalParams |
Paramètres facultatifs. |
| DeploymentsWhatIfOptionalParams |
Paramètres facultatifs. |
| ErrorAdditionalInfo |
Informations supplémentaires sur l’erreur de gestion des ressources. |
| ErrorResponse |
Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.) |
| ExpressionEvaluationOptions |
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. |
| ExtensionResource |
Ressource d’extension de base. |
| HttpMessage |
Message HTTP. |
| KeyVaultParameterReference |
Informations de référence sur les paramètres Azure Key Vault. |
| KeyVaultReference |
Informations de référence sur Azure Key Vault. |
| OnErrorDeployment |
Déploiement sur le comportement d’erreur. |
| OnErrorDeploymentExtended |
Déploiement sur le comportement des erreurs avec des détails supplémentaires. |
| PageSettings |
Options de la méthode byPage |
| PagedAsyncIterableIterator |
Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page. |
| ParametersLink |
Entité représentant la référence aux paramètres de déploiement. |
| Provider |
Informations du fournisseur de ressources. |
| ProviderExtendedLocation |
Emplacement étendu du fournisseur. |
| ProviderResourceType |
Type de ressource géré par le fournisseur de ressources. |
| Resource |
Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager |
| ResourceReference |
Modèle ID de ressource. |
| RestorePollerOptions | |
| ScopedDeployment |
Paramètres d’opération de déploiement. |
| ScopedDeploymentWhatIf |
Paramètres d’opération de simulation de déploiement. |
| SimplePollerLike |
Un polleur simple qui peut être utilisé pour interroger une opération de longue durée. |
| StatusMessage |
Objet message d’état de l’opération. |
| SystemData |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
| TargetResource |
Ressource cible. |
| TemplateHashResult |
Résultat de la requête pour calculer le hachage du modèle. Il contient une chaîne de modèle minifié et son hachage. |
| TemplateLink |
Entité représentant la référence au modèle. |
| UserAssignedIdentity |
Propriétés d’identité attribuées par l’utilisateur |
| WhatIfChange |
Informations sur une seule modification de ressource prédite par What-If opération. |
| WhatIfOperationProperties |
Propriétés de l’opération de déploiement. |
| WhatIfOperationResult |
Résultat de l’opération de What-If. Contient une liste des modifications prédites et un lien d’URL pour accéder au jeu de résultats suivant. |
| WhatIfPropertyChange |
Modification prédite de la propriété de ressource. |
| ZoneMapping |
Interface de modèle ZoneMapping |
Alias de type
| AliasPathAttributes |
Attributs du jeton auquel le chemin d’accès de l’alias fait référence. Valeurs connues prises en charge par le service
Aucun: jeton auquel le chemin d’accès de l’alias fait référence n’a aucun attribut. |
| AliasPathTokenType |
Type du jeton auquel le chemin d’accès de l’alias fait référence. Valeurs connues prises en charge par le service
NotSpecified: le type de jeton n’est pas spécifié. |
| AliasPatternType |
Type de modèle d’alias |
| AliasType |
Type de l’alias. |
| AzureSupportedClouds |
Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne |
| ChangeType |
Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement. |
| ContinuablePage |
Interface qui décrit une page de résultats. |
| CreatedByType |
Type d’entité qui a créé la ressource. Valeurs connues prises en charge par le service
'utilisateur: l’entité a été créée par un utilisateur. |
| DeploymentIdentityType |
Type d’identité. Valeurs connues prises en charge par le service
Aucun : Aucun |
| DeploymentMode |
Mode utilisé pour déployer des ressources. Cette valeur peut être incrémentielle ou terminée. En mode incrémentiel, les ressources sont déployées sans supprimer les ressources existantes qui ne sont pas incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes dans le groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Veillez à utiliser le mode Complet, car vous pouvez supprimer involontairement des ressources. |
| DeploymentsCheckExistenceAtManagementGroupScopeResponse | |
| DeploymentsCheckExistenceAtScopeResponse | |
| DeploymentsCheckExistenceAtSubscriptionScopeResponse | |
| DeploymentsCheckExistenceAtTenantScopeResponse | |
| DeploymentsCheckExistenceResponse | |
| ExpressionEvaluationOptionsScopeType |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. Valeurs connues prises en charge par le service
NotSpecified : NotSpecified |
| ExtensionConfigPropertyType |
Type d’extensionConfigurationPropriétéType |
| Level |
Indique le niveau de réponse supplémentaire. Valeurs connues prises en charge par le service
Avertissement : Avertissement |
| OnErrorDeploymentType |
Déploiement sur le type de comportement d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. |
| PropertyChangeType |
Type de modification de propriété. |
| ProviderAuthorizationConsentState |
État du consentement d’autorisation du fournisseur. Valeurs connues prises en charge par le service
NotSpecified : NotSpecified |
| ProvisioningOperation |
Nom de l’opération d’approvisionnement actuelle. |
| ProvisioningState |
Indique l’état de l’approvisionnement. Valeurs connues prises en charge par le service
NotSpecified : NotSpecified |
| ValidationLevel |
Niveau de validation effectué sur le déploiement. Valeurs connues prises en charge par le service
Modèle : Une analyse statique du modèle est effectuée. |
| WhatIfResultFormat |
Format des résultats What-If |
Énumérations
| AzureClouds |
Un enum pour décrire les environnements Azure Cloud. |
| KnownAliasPathAttributes |
Attributs du jeton auquel le chemin d’accès de l’alias fait référence. |
| KnownAliasPathTokenType |
Type du jeton auquel le chemin d’accès de l’alias fait référence. |
| KnownCreatedByType |
Type d’entité qui a créé la ressource. |
| KnownDeploymentIdentityType |
Type d’identité. |
| KnownExpressionEvaluationOptionsScopeType |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. |
| KnownExtensionConfigPropertyType |
Valeurs connues de ExtensionConfigPropertyType acceptées par le service. |
| KnownLevel |
Indique le niveau de réponse supplémentaire. |
| KnownProviderAuthorizationConsentState |
État du consentement d’autorisation du fournisseur. |
| KnownProvisioningState |
Indique l’état de l’approvisionnement. |
| KnownValidationLevel |
Niveau de validation effectué sur le déploiement. |
| KnownVersions |
Versions d’API disponibles. |
Functions
| is |
Typeguard pour RestError |
| restore |
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue. |
Variables
| Rest |
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué. |
Informations relatives à la fonction
isRestError(unknown)
Typeguard pour RestError
function isRestError(e: unknown): e
Paramètres
- e
-
unknown
Quelque chose d’intercepté par une clause catch.
Retours
e
restorePoller<TResponse, TResult>(DeploymentsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.
function restorePoller<TResponse, TResult>(client: DeploymentsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Paramètres
- client
- DeploymentsClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retours
PollerLike<OperationState<TResult>, TResult>
Détails de variable
RestError
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RestError: RestErrorConstructor