Partilhar via


ResourcesOperations Classe

Aviso

NÃO instanciar esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

ResourceManagementClient's

<xref:resources> atributo.

Herança
builtins.object
ResourcesOperations

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. 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. 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.

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
Necessário

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
Necessário

O espaço de nomes do fornecedor de recursos. Obrigatório.

parent_resource_path
str
Necessário

A identidade do recurso principal. Obrigatório.

resource_type
str
Necessário

O tipo de recurso do recurso a criar. Obrigatório.

resource_name
str
Necessário

O nome do recurso a criar. Obrigatório.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

parameters
GenericResource ou IO
Necessário

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 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_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
Necessário

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.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

parameters
GenericResource ou IO
Necessário

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 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_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
Necessário

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
Necessário

O espaço de nomes do fornecedor de recursos. Obrigatório.

parent_resource_path
str
Necessário

A identidade do recurso principal. Obrigatório.

resource_type
str
Necessário

O tipo de recurso. Obrigatório.

resource_name
str
Necessário

O nome do recurso a eliminar. Obrigatório.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

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

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
Necessário

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.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

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

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. 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
Necessário

O nome do grupo de recursos que contém os recursos a mover. Obrigatório.

parameters
ResourcesMoveInfo ou IO
Necessário

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(response)

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
Necessário

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
Necessário

O espaço de nomes do fornecedor de recursos. Obrigatório.

parent_resource_path
str
Necessário

A identidade do recurso principal. Obrigatório.

resource_type
str
Necessário

O tipo de recurso do recurso a atualizar. Obrigatório.

resource_name
str
Necessário

O nome do recurso a atualizar. Obrigatório.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

parameters
GenericResource ou IO
Necessário

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 à 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_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
Necessário

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.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

parameters
GenericResource ou IO
Necessário

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_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. 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
Necessário

O nome do grupo de recursos que contém os recursos para validar a movimentação. Obrigatório.

parameters
ResourcesMoveInfo ou IO
Necessário

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(response)

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) -> bool

Parâmetros

resource_group_name
str
Necessário

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
Necessário

O fornecedor de recursos do recurso a verificar. Obrigatório.

parent_resource_path
str
Necessário

A identidade do recurso principal. Obrigatório.

resource_type
str
Necessário

O tipo de recurso. Obrigatório.

resource_name
str
Necessário

O nome do recurso para verificar se existe. Obrigatório.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

bool ou o resultado de cls(response)

Tipo de retorno

Exceções

check_existence_by_id

Verifica por ID se existe um recurso.

check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool

Parâmetros

resource_id
str
Necessário

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.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

bool ou o resultado de cls(response)

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) -> GenericResource

Parâmetros

resource_group_name
str
Necessário

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
Necessário

O espaço de nomes do fornecedor de recursos. Obrigatório.

parent_resource_path
str
Necessário

A identidade do recurso principal. Obrigatório.

resource_type
str
Necessário

O tipo de recurso do recurso. Obrigatório.

resource_name
str
Necessário

O nome do recurso a obter. Obrigatório.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido à 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) -> GenericResource

Parâmetros

resource_id
str
Necessário

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.

api_version
str
Necessário

A versão da API a utilizar para a operação. Obrigatório.

cls
callable

Um tipo ou função personalizado que será transmitido à 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
Necessário

O filtro a aplicar na operação.:code:
<br>As propriedades que pode utilizar para eq (igual a) ou ne (não igual a) 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 substringof(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::code:>><<<br>Pode utilizar algumas propriedades em conjunto ao filtrar. As combinações que pode utilizar são: subcadeia de e/ou resourceType, plano e plano/publicador e plano/nome, identidade e identidade/principalId. O valor predefinido é Nenhum.

expand
str
Necessário

Lista separada por vírgulas de propriedades adicionais a incluir na resposta. Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime. O valor predefinido é Nenhum.

top
int
Necessário

O número de resultados a devolver. Se for transmitido um valor nulo, devolve todos os recursos. O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido à 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

resource_group_name
str
Necessário

O grupo de recursos com os recursos a obter. Obrigatório.

filter
str
Necessário

O filtro a aplicar na operação.:code:
<br>As propriedades que pode utilizar para eq (igual a) ou ne (não igual a) 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 substringof(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::code:>><<<br>Pode utilizar algumas propriedades em conjunto ao filtrar. As combinações que pode utilizar são: subcadeia de e/ou resourceType, plano e plano/publicador e plano/nome, identidade e identidade/principalId. O valor predefinido é Nenhum.

expand
str
Necessário

Lista separada por vírgulas de propriedades adicionais a incluir na resposta. Os valores válidos incluem createdTime, changedTime e provisioningState. Por exemplo, $expand=createdTime,changedTime. O valor predefinido é Nenhum.

top
int
Necessário

O número de resultados a devolver. Se for transmitido um valor nulo, devolve todos os recursos. O valor predefinido é Nenhum.

cls
callable

Um tipo ou função personalizado que será transmitido à 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.v2020_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>