ResourcesOperations Classe
Aviso
NÃO instancia esta classe diretamente.
Em vez disso, deve aceder às seguintes operações através de
<xref:resources> atributo.
- Herança
-
builtins.objectResourcesOperations
Construtor
ResourcesOperations(*args, **kwargs)Métodos
| begin_create_or_update |
Cria um recurso. |
| begin_create_or_update_by_id |
Criar um recurso por ID. |
| begin_delete |
Elimina um recurso. |
| begin_delete_by_id |
Elimina um recurso por ID. |
| begin_move_resources |
Move recursos de um grupo de recursos para outro grupo de recursos. Os recursos a mover têm de estar no mesmo grupo de recursos de origem na subscrição de origem que está a ser utilizada. O grupo de recursos de destino pode estar numa subscrição diferente. Ao mover recursos, tanto o grupo de origem como o grupo de destino são bloqueados durante a operação. As operações de escrita e eliminação são bloqueadas nos grupos até que a movimentação seja concluída. |
| begin_update |
Atualizações um recurso. |
| begin_update_by_id |
Atualizações um recurso por ID. |
| begin_validate_move_resources |
Valida se os recursos podem ser movidos de um grupo de recursos para outro grupo de recursos. Esta operação verifica se os recursos especificados podem ser movidos para o destino. Os recursos a mover têm de estar no mesmo grupo de recursos de origem na subscrição de origem que está a ser utilizada. O grupo de recursos de destino pode estar numa subscrição diferente. Se a validação for bem-sucedida, devolve o código de resposta HTTP 204 (sem conteúdo). Se a validação falhar, devolve o código de resposta HTTP 409 (Conflito) com uma mensagem de erro. Obtenha o URL no valor do cabeçalho Localização para verificar o resultado da operação de execução prolongada. |
| check_existence |
Verifica se existe um recurso. |
| check_existence_by_id |
Verifica por ID se existe um recurso. Atualmente, esta API funciona apenas para um conjunto limitado de Fornecedores de recursos. Caso um Fornecedor de recursos não implemente esta API, o ARM responderá com um 405. Em seguida, a alternativa é utilizar a API GET para verificar a existência do recurso. |
| get |
Obtém um recurso. |
| get_by_id |
Obtém um recurso por ID. |
| list |
Obtenha todos os recursos numa subscrição. |
| list_by_resource_group |
Obtenha todos os recursos de um grupo de recursos. |
begin_create_or_update
Cria um recurso.
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]Parâmetros
- resource_group_name
- str
O nome do grupo de recursos do recurso. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.
- resource_provider_namespace
- str
O espaço de nomes do fornecedor de recursos. Obrigatório.
- parameters
- GenericResource ou IO
Parâmetros para criar ou atualizar o recurso. É um tipo genericResource ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não estiver presente nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_create_or_update_by_id
Criar um recurso por 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]Parâmetros
- resource_id
- str
O ID completamente qualificado do recurso, incluindo o nome do recurso e o tipo de recurso. Utilize o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatório.
- parameters
- GenericResource ou IO
Criar ou atualizar parâmetros de recursos. É um tipo genericResource ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não estiver presente nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_delete
Elimina um recurso.
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]Parâmetros
- resource_group_name
- str
O nome do grupo de recursos que contém o recurso a eliminar. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.
- resource_provider_namespace
- str
O espaço de nomes do fornecedor de recursos. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não estiver presente nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_delete_by_id
Elimina um recurso por ID.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]Parâmetros
- resource_id
- str
O ID completamente qualificado do recurso, incluindo o nome do recurso e o tipo de recurso. Utilize o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não estiver presente nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_move_resources
Move recursos de um grupo de recursos para outro grupo de recursos.
Os recursos a mover têm de estar no mesmo grupo de recursos de origem na subscrição de origem que está a ser utilizada. O grupo de recursos de destino pode estar numa subscrição diferente. Ao mover recursos, tanto o grupo de origem como o grupo de destino são bloqueados durante a operação. As operações de escrita e eliminação são bloqueadas nos grupos até que a movimentação seja concluída.
begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]Parâmetros
- source_resource_group_name
- str
O nome do grupo de recursos da subscrição de origem que contém os recursos a mover. Obrigatório.
- parameters
- ResourcesMoveInfo ou IO
Parâmetros para mover recursos. É um tipo ResourcesMoveInfo ou de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não estiver presente nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve Nenhum ou o resultado de cls(resposta)
Tipo de retorno
Exceções
begin_update
Atualizações um recurso.
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]Parâmetros
- resource_group_name
- str
O nome do grupo de recursos do recurso. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.
- resource_provider_namespace
- str
O espaço de nomes do fornecedor de recursos. Obrigatório.
- parameters
- GenericResource ou IO
Parâmetros para atualizar o recurso. É um tipo GenericResource ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_update_by_id
Atualizações um recurso por ID.
begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]Parâmetros
- resource_id
- str
O ID completamente qualificado do recurso, incluindo o nome do recurso e o tipo de recurso. Utilize o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatório.
- parameters
- GenericResource ou IO
Atualizar parâmetros de recursos. É um tipo GenericResource ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
begin_validate_move_resources
Valida se os recursos podem ser movidos de um grupo de recursos para outro grupo de recursos.
Esta operação verifica se os recursos especificados podem ser movidos para o destino. Os recursos a mover têm de estar no mesmo grupo de recursos de origem na subscrição de origem que está a ser utilizada. O grupo de recursos de destino pode estar numa subscrição diferente. Se a validação for bem-sucedida, devolve o código de resposta HTTP 204 (sem conteúdo). Se a validação falhar, devolve o código de resposta HTTP 409 (Conflito) com uma mensagem de erro. Obtenha o URL no valor do cabeçalho Localização para verificar o resultado da operação de execução prolongada.
begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]Parâmetros
- source_resource_group_name
- str
O nome do grupo de recursos da subscrição de origem que contém os recursos a validar para movimentação. Obrigatório.
- parameters
- ResourcesMoveInfo ou IO
Parâmetros para mover recursos. É um tipo ResourcesMoveInfo ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve Nenhum ou o resultado de cls(resposta)
Tipo de retorno
Exceções
check_existence
Verifica se existe um recurso.
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) -> boolParâmetros
- resource_group_name
- str
O nome do grupo de recursos que contém o recurso a verificar. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.
- resource_provider_namespace
- str
O fornecedor de recursos do recurso a verificar. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
bool ou o resultado de cls(resposta)
Tipo de retorno
Exceções
check_existence_by_id
Verifica por ID se existe um recurso. Atualmente, esta API funciona apenas para um conjunto limitado de Fornecedores de recursos. Caso um Fornecedor de recursos não implemente esta API, o ARM responderá com um 405. Em seguida, a alternativa é utilizar a API GET para verificar a existência do recurso.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> boolParâmetros
- resource_id
- str
O ID completamente qualificado do recurso, incluindo o nome do recurso e o tipo de recurso. Utilize o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
bool ou o resultado de cls(resposta)
Tipo de retorno
Exceções
get
Obtém um recurso.
get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResourceParâmetros
- resource_group_name
- str
O nome do grupo de recursos que contém o recurso a obter. O nome não é sensível a maiúsculas e minúsculas. Obrigatório.
- resource_provider_namespace
- str
O espaço de nomes do fornecedor de recursos. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
get_by_id
Obtém um recurso por ID.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResourceParâmetros
- resource_id
- str
O ID completamente qualificado do recurso, incluindo o nome do recurso e o tipo de recurso. Utilize o formato /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
GenericResource ou o resultado de cls(response)
Tipo de retorno
Exceções
list
Obtenha todos os recursos numa subscrição.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]Parâmetros
- filter
- str
O filtro a aplicar na operação.:code:<br>Os operadores de comparação de filtros incluem eq (iguais) e ne (não iguais) e podem ser utilizados com as seguintes propriedades: location, resourceType, , name, resourceGroup, identity , identity/principalId, plan, plan/publisher, plan/product, plan/nameplan/versione plan/promotionCode.:code:<br>Por exemplo, para filtrar por um tipo de recurso, utilize $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 e/`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, as etiquetas originais para cada recurso não serão devolvidas nos resultados.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 and plan/publisher and plan/name, and identity and identity/principalId'. O valor predefinido é Nenhum.
- expand
- str
Lista separada por vírgulas de propriedades adicionais a incluir na resposta.
Os valores válidos incluem createdTimee changedTimeprovisioningState. Por exemplo, $expand=createdTime,changedTime. O valor predefinido é Nenhum.
- top
- int
O número de recomendações por página se estiver a ser utilizada uma versão paginada desta API. O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de GenericResourceExpanded ou o resultado de cls(response)
Tipo de retorno
Exceções
list_by_resource_group
Obtenha todos os recursos de um grupo de recursos.
list_by_resource_group(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]Parâmetros
- filter
- str
O filtro a aplicar na operação.:code:<br>As propriedades que pode utilizar para eq (igual a) ou ne (não igual) são: localização, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version e plan/promotionCode.:code:<br>``<br>Por exemplo, para filtrar por um tipo de recurso, utilize: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>Pode utilizar subcadeia(valor, propriedade) no filtro. As propriedades que pode utilizar para subcadeia são: nome e resourceGroup.:code:<br>``<br>Por exemplo, para obter todos os recursos com "demonstração" em qualquer lugar no nome, utilize: $filter=substringof('demo', name):code:<br>``<br>Pode ligar mais do que uma subcadeia ao adicionar e/ou operadores.:código:<br>``<br>Pode filtrar por nomes de etiquetas e valores. Por exemplo, para filtrar um nome e valor de etiqueta, utilize $filter=tagName eq 'tag1' e tagValue eq 'Value1'. Quando filtra por um nome e valor de etiqueta, as etiquetas para cada recurso não são devolvidas nos resultados.:code::<br>code:>><<<br>Pode utilizar algumas propriedades em conjunto ao filtrar. As combinações que pode utilizar são: subcadeia e/ou resourceType, plano e plano/publicador e plano/nome, identidade e identidade/principalId. O valor predefinido é Nenhum.
- expand
- str
Lista separada por vírgulas de propriedades adicionais a incluir na resposta.
Os valores válidos incluem createdTimee changedTimeprovisioningState. Por exemplo, $expand=createdTime,changedTime. O valor predefinido é Nenhum.
- top
- int
O número de resultados a devolver. Se for transmitido nulo, devolve todos os recursos. O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de GenericResourceExpanded ou o resultado de cls(response)
Tipo de retorno
Exceções
Atributos
models
models = <module 'azure.mgmt.resource.resources.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2022_09_01\\models\\__init__.py'>
Azure SDK for Python
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários