ResourcesOperations Classe
Avertissement
NE PAS instancier cette classe directement.
Au lieu de cela, vous devez accéder aux opérations suivantes via
attribut<xref:resources> ;
- Héritage
-
builtins.objectResourcesOperations
Constructeur
ResourcesOperations(*args, **kwargs)
Méthodes
begin_create_or_update |
Crée une ressource. |
begin_create_or_update_by_id |
Créez une ressource par ID. |
begin_delete |
Supprime une ressource. |
begin_delete_by_id |
Supprime une ressource par ID. |
begin_move_resources |
Déplace des ressources d’un groupe de ressources vers un autre groupe de ressources. Les ressources à déplacer doivent se trouver dans le même groupe de ressources source dans l’abonnement source utilisé. Le groupe de ressources cible peut se trouver dans un autre abonnement. Lors du déplacement de ressources, le groupe source et le groupe cible sont verrouillés pendant la durée de l’opération. Les opérations d’écriture et de suppression sont bloquées sur les groupes tant que le déplacement n’est pas terminé. |
begin_update |
Met à jour une ressource. |
begin_update_by_id |
Mises à jour une ressource par ID. |
begin_validate_move_resources |
Vérifie si les ressources peuvent être déplacées d’un groupe de ressources vers un autre groupe de ressources. Cette opération vérifie si les ressources spécifiées peuvent être déplacées vers la cible. Les ressources à déplacer doivent se trouver dans le même groupe de ressources source dans l’abonnement source utilisé. Le groupe de ressources cible peut se trouver dans un autre abonnement. Si la validation réussit, elle retourne le code de réponse HTTP 204 (aucun contenu). Si la validation échoue, elle retourne le code de réponse HTTP 409 (Conflit) avec un message d’erreur. Récupérez l’URL dans la valeur d’en-tête Location pour case activée le résultat de l’opération de longue durée. |
check_existence |
Vérifie si une ressource existe. |
check_existence_by_id |
Vérifie par ID si une ressource existe. Cette API fonctionne actuellement uniquement pour un ensemble limité de fournisseurs de ressources. Si un fournisseur de ressources n’implémente pas cette API, ARM répond avec un 405. L’alternative consiste alors à utiliser l’API GET pour case activée l’existence de la ressource. |
get |
Obtient une ressource. |
get_by_id |
Obtient une ressource par ID. |
list |
Obtenez toutes les ressources d’un abonnement. |
list_by_resource_group |
Obtenez toutes les ressources d’un groupe de ressources. |
begin_create_or_update
Crée une ressource.
begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Paramètres
- resource_group_name
- str
Nom du groupe de ressources pour la ressource. Le nom ne respecte pas la casse. Obligatoire.
- resource_provider_namespace
- str
Espace de noms du fournisseur de ressources. Obligatoire.
- parameters
- GenericResource ou IO
Paramètres de création ou de mise à jour de la ressource. Est un type GenericResource ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
begin_create_or_update_by_id
Créez une ressource par ID.
begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Paramètres
- resource_id
- str
Identifiant complet de la ressource, y compris le nom et le type de la ressource. Utilisez le format /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obligatoire.
- parameters
- GenericResource ou IO
Créer ou mettre à jour les paramètres de la ressource. Est un type GenericResource ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
begin_delete
Supprime une ressource.
begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Paramètres
- resource_group_name
- str
Nom du groupe de ressources qui contient la ressource à supprimer. Le nom ne respecte pas la casse. Obligatoire.
- resource_provider_namespace
- str
Espace de noms du fournisseur de ressources. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne none ou le résultat de cls(response)
Type de retour
Exceptions
begin_delete_by_id
Supprime une ressource par ID.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Paramètres
- resource_id
- str
Identifiant complet de la ressource, y compris le nom et le type de la ressource. Utilisez le format /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne none ou le résultat de cls(response)
Type de retour
Exceptions
begin_move_resources
Déplace des ressources d’un groupe de ressources vers un autre groupe de ressources.
Les ressources à déplacer doivent se trouver dans le même groupe de ressources source dans l’abonnement source utilisé. Le groupe de ressources cible peut se trouver dans un autre abonnement. Lors du déplacement de ressources, le groupe source et le groupe cible sont verrouillés pendant la durée de l’opération. Les opérations d’écriture et de suppression sont bloquées sur les groupes tant que le déplacement n’est pas terminé.
begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Paramètres
- source_resource_group_name
- str
Nom du groupe de ressources de l’abonnement source contenant les ressources à déplacer. Obligatoire.
- parameters
- ResourcesMoveInfo ou IO
Paramètres pour le déplacement des ressources. Est un type ResourcesMoveInfo ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne none ou le résultat de cls(response)
Type de retour
Exceptions
begin_update
Met à jour une ressource.
begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Paramètres
- resource_group_name
- str
Nom du groupe de ressources pour la ressource. Le nom ne respecte pas la casse. Obligatoire.
- resource_provider_namespace
- str
Espace de noms du fournisseur de ressources. Obligatoire.
- parameters
- GenericResource ou IO
Paramètres de mise à jour de la ressource. Est un type GenericResource ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
begin_update_by_id
Mises à jour une ressource par ID.
begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Paramètres
- resource_id
- str
Identifiant complet de la ressource, y compris le nom et le type de la ressource. Utilisez le format /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obligatoire.
- parameters
- GenericResource ou IO
Mettez à jour les paramètres de ressource. Est un type GenericResource ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
begin_validate_move_resources
Vérifie si les ressources peuvent être déplacées d’un groupe de ressources vers un autre groupe de ressources.
Cette opération vérifie si les ressources spécifiées peuvent être déplacées vers la cible. Les ressources à déplacer doivent se trouver dans le même groupe de ressources source dans l’abonnement source utilisé. Le groupe de ressources cible peut se trouver dans un autre abonnement. Si la validation réussit, elle retourne le code de réponse HTTP 204 (aucun contenu). Si la validation échoue, elle retourne le code de réponse HTTP 409 (Conflit) avec un message d’erreur. Récupérez l’URL dans la valeur d’en-tête Location pour case activée le résultat de l’opération de longue durée.
begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Paramètres
- source_resource_group_name
- str
Nom du groupe de ressources de l’abonnement source contenant les ressources à valider pour le déplacement. Obligatoire.
- parameters
- ResourcesMoveInfo ou IO
Paramètres pour le déplacement des ressources. Est un type ResourcesMoveInfo ou un type d’E/S. Obligatoire.
- content_type
- str
Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
- continuation_token
- str
Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.
- polling
- bool ou PollingMethod
Par défaut, votre méthode d’interrogation est ARMPolling. Passez la valeur False pour que cette opération n’interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.
- polling_interval
- int
Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.
Retours
Instance de LROPoller qui retourne none ou le résultat de cls(response)
Type de retour
Exceptions
check_existence
Vérifie si une ressource existe.
check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> bool
Paramètres
- resource_group_name
- str
Nom du groupe de ressources contenant la ressource à case activée. Le nom ne respecte pas la casse. Obligatoire.
- resource_provider_namespace
- str
Fournisseur de ressources de la ressource à case activée. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
bool ou le résultat de cls(response)
Type de retour
Exceptions
check_existence_by_id
Vérifie par ID si une ressource existe. Cette API fonctionne actuellement uniquement pour un ensemble limité de fournisseurs de ressources. Si un fournisseur de ressources n’implémente pas cette API, ARM répond avec un 405. L’alternative consiste alors à utiliser l’API GET pour case activée l’existence de la ressource.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool
Paramètres
- resource_id
- str
Identifiant complet de la ressource, y compris le nom et le type de la ressource. Utilisez le format /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
bool ou le résultat de cls(response)
Type de retour
Exceptions
get
Obtient une ressource.
get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResource
Paramètres
- resource_group_name
- str
Nom du groupe de ressources contenant la ressource à obtenir. Le nom ne respecte pas la casse. Obligatoire.
- resource_provider_namespace
- str
Espace de noms du fournisseur de ressources. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
get_by_id
Obtient une ressource par ID.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource
Paramètres
- resource_id
- str
Identifiant complet de la ressource, y compris le nom et le type de la ressource. Utilisez le format /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obligatoire.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
GenericResource ou le résultat de cls(response)
Type de retour
Exceptions
list
Obtenez toutes les ressources d’un abonnement.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Paramètres
- filter
- str
Filtre à appliquer sur l’opération.:code :<br>
Les opérateurs de comparaison de filtre incluent eq
(est égal) et ne
(non égal) et peuvent être utilisés avec les propriétés suivantes : location
, , identity
identity/principalId
resourceGroup
plan
plan/publisher
resourceType
name
, plan/name
plan/product
plan/version
et plan/promotionCode
.:code :<br>
Par exemple, pour filtrer par type de ressource, utilisez $filter=resourceType eq 'Microsoft.Network/virtualNetworks'```<br>
<br>` `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup
<br>`For example, to get all resources with 'demo' anywhere in the resource name, use
$filter=substringof('demo', name)'''<br>`Multiple substring operations can also be combined using
et/`or` operators.:code:*<br>*`<br>`Note that any truncated number of results queried via
$top may also not be compatible when using a filter.:code:*<br>*`<br>
Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use ``$filter=tagName eq 'tag1' and tagValue eq 'Value1'``. Note that when resources are filtered by tag name and value,
les balises d’origine pour chaque ressource ne seront pas retournées dans les résultats.Any list of additional properties queried via
$expandmay also not be compatible when filtering by tag names/values.
<br>`For tag names only, resources can be filtered by prefix using the following syntax:
$filter=startswith(tagName, 'depart'). This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.):code:*<br>*`<br>
Note that some properties can be combined when filtering resources, which include the following: ``substringof() and/or resourceType``,
plan et plan/publisher et plan/name, and
identity/principalId'. La valeur par défaut est Aucun.
- expand
- str
Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse.
Les valeurs valides incluent createdTime
, changedTime
et provisioningState
. Par exemple : $expand=createdTime,changedTime
. La valeur par défaut est Aucun.
- top
- int
Nombre de recommandations par page si une version paginée de cette API est utilisée. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
Un itérateur comme instance de GenericResourceExpanded ou le résultat de cls(response)
Type de retour
Exceptions
list_by_resource_group
Obtenez toutes les ressources d’un groupe de ressources.
list_by_resource_group(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Paramètres
- resource_group_name
- str
Groupe de ressources avec les ressources à obtenir. Obligatoire.
- filter
- str
Filtre à appliquer sur l’opération.:code :<br>
Les propriétés que vous pouvez utiliser pour eq (égal) ou ne (non égal) sont les suivantes : emplacement, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version et plan/promotionCode.:code:<br>``<br>
Par exemple, pour filtrer par un type de ressource, utilisez : $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>
Vous pouvez utiliser substringof(value, property) dans le filtre. Les propriétés que vous pouvez utiliser pour la sous-chaîne sont les suivantes : name et resourceGroup.:code:<br>``<br>
Par exemple, pour obtenir toutes les ressources avec 'demo' n’importe où dans le nom, utilisez : $filter=substringof('demo', name):code:<br>``<br>
Vous pouvez lier plusieurs sous-chaînesof en ajoutant et/ou opérateurs.:code:<br>``<br>
Vous pouvez filtrer par noms et valeurs de balise. Par exemple, pour filtrer un nom et une valeur de balise, utilisez $filter=tagName eq 'tag1' et tagValue eq 'Value1'. Lorsque vous filtrez par un nom de balise et une valeur, les balises de chaque ressource ne sont pas retournées dans les résultats.:code:<br>
Code:>><<<br>
Vous pouvez utiliser certaines propriétés ensemble lors du filtrage. Les combinaisons que vous pouvez utiliser sont les suivantes : sous-chaîneof et/ou resourceType, plan et plan/publisher et plan/name, identity et identity/principalId. La valeur par défaut est Aucun.
- expand
- str
Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse.
Les valeurs valides incluent createdTime
, changedTime
et provisioningState
. Par exemple : $expand=createdTime,changedTime
. La valeur par défaut est Aucun.
- top
- int
Nombre de résultats à retourner. Si la valeur null est transmise, retourne toutes les ressources. La valeur par défaut est Aucun.
- cls
- callable
Type ou fonction personnalisé qui recevra la réponse directe
Retours
Un itérateur comme instance de GenericResourceExpanded ou le résultat de cls(response)
Type de retour
Exceptions
Attributs
models
models = <module 'azure.mgmt.resource.resources.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_04_01\\models\\__init__.py'>
Azure SDK for Python