DeploymentsOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

ResourceManagementClient's

Atributo <xref:deployments>.

Herança

builtins.object

DeploymentsOperations

Construtor

DeploymentsOperations(*args, **kwargs)

Métodos

begin_create_or_update	Implanta recursos em um grupo de recursos. Você pode fornecer o modelo e os parâmetros diretamente na solicitação ou no link para arquivos JSON.
begin_create_or_update_at_subscription_scope	Implanta recursos no escopo da assinatura. Você pode fornecer o modelo e os parâmetros diretamente na solicitação ou no link para arquivos JSON.
begin_delete	Exclui uma implantação do histórico de implantação. Uma implantação do modelo que está atualmente em execução não pode ser excluída. Excluir uma implantação do modelo remove as operações de implantação associadas. Excluir uma implantação do modelo não afeta o estado do grupo de recursos. Essa é uma operação assíncrona que retorna um status de 202 até que a implantação do modelo seja excluída com êxito. O cabeçalho de resposta Local contém o URI usado para obter o status do processo. Enquanto o processo está em execução, uma chamada para o URI no cabeçalho Local retorna um status de 202. Quando o processo é concluído, o URI no cabeçalho Local retorna um status de 204 com êxito. Se a solicitação assíncrona falhar, o URI no cabeçalho Local retornará um código de status no nível de erro.
begin_delete_at_subscription_scope	Exclui uma implantação do histórico de implantação. Uma implantação do modelo que está atualmente em execução não pode ser excluída. Excluir uma implantação do modelo remove as operações de implantação associadas. Essa é uma operação assíncrona que retorna um status de 202 até que a implantação do modelo seja excluída com êxito. O cabeçalho de resposta Local contém o URI usado para obter o status do processo. Enquanto o processo está em execução, uma chamada para o URI no cabeçalho Local retorna um status de 202. Quando o processo é concluído, o URI no cabeçalho Local retorna um status de 204 com êxito. Se a solicitação assíncrona falhar, o URI no cabeçalho Local retornará um código de status no nível de erro.
calculate_template_hash	Calcule o hash do modelo especificado.
cancel	Cancela uma implantação de modelo em execução no momento. Você só poderá cancelar uma implantação se o provisioningState for Aceito ou Em Execução. Depois que a implantação é cancelada, o provisioningState é definido como Cancelado. Cancelar uma implantação de modelo para a implantação de modelo atualmente em execução e deixa o grupo de recursos parcialmente implantado.
cancel_at_subscription_scope	Cancela uma implantação de modelo em execução no momento. Você só poderá cancelar uma implantação se o provisioningState for Aceito ou Em Execução. Depois que a implantação é cancelada, o provisioningState é definido como Cancelado. O cancelamento de uma implantação de modelo interrompe a implantação de modelo em execução no momento e deixa os recursos parcialmente implantados.
check_existence	Verifica se a implantação existe.
check_existence_at_subscription_scope	Verifica se a implantação existe.
export_template	Exporta o modelo usado para a implantação especificada.
export_template_at_subscription_scope	Exporta o modelo usado para a implantação especificada.
get	Obtém uma implantação.
get_at_subscription_scope	Obtém uma implantação.
list_at_subscription_scope	Obtenha todas as implantações de uma assinatura.
list_by_resource_group	Obter todas as implantações de um grupo de recursos.
validate	Valida se o modelo especificado está sintaticamente correto e será aceito pelo Azure Resource Manager..
validate_at_subscription_scope	Valida se o modelo especificado está sintaticamente correto e será aceito pelo Azure Resource Manager..

begin_create_or_update

Implanta recursos em um grupo de recursos.

Você pode fornecer o modelo e os parâmetros diretamente na solicitação ou no link para arquivos JSON.

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos no qual implantar os recursos. O nome diferencia maiúsculas de minúsculas. O grupo de recursos já precisa existir. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação. Obrigatórios.

parameters

Deployment ou IO

Obrigatório

Parâmetros adicionais fornecidos para a operação. É um tipo de implantação ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de LROPoller que retorna DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

LROPoller[DeploymentExtended]

Exceções

HttpResponseError

begin_create_or_update_at_subscription_scope

Implanta recursos no escopo da assinatura.

Você pode fornecer o modelo e os parâmetros diretamente na solicitação ou no link para arquivos JSON.

begin_create_or_update_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação. Obrigatórios.

parameters

Deployment ou IO

Obrigatório

Parâmetros adicionais fornecidos para a operação. É um tipo de implantação ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de LROPoller que retorna DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

LROPoller[DeploymentExtended]

Exceções

HttpResponseError

begin_delete

Exclui uma implantação do histórico de implantação.

Uma implantação do modelo que está atualmente em execução não pode ser excluída. Excluir uma implantação do modelo remove as operações de implantação associadas. Excluir uma implantação do modelo não afeta o estado do grupo de recursos. Essa é uma operação assíncrona que retorna um status de 202 até que a implantação do modelo seja excluída com êxito. O cabeçalho de resposta Local contém o URI usado para obter o status do processo. Enquanto o processo está em execução, uma chamada para o URI no cabeçalho Local retorna um status de 202. Quando o processo é concluído, o URI no cabeçalho Local retorna um status de 204 com êxito. Se a solicitação assíncrona falhar, o URI no cabeçalho Local retornará um código de status no nível de erro.

begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos com a implantação a ser excluída. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação a ser excluída. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)

Tipo de retorno

LROPoller[None]

Exceções

HttpResponseError

begin_delete_at_subscription_scope

Exclui uma implantação do histórico de implantação.

Uma implantação do modelo que está atualmente em execução não pode ser excluída. Excluir uma implantação do modelo remove as operações de implantação associadas. Essa é uma operação assíncrona que retorna um status de 202 até que a implantação do modelo seja excluída com êxito. O cabeçalho de resposta Local contém o URI usado para obter o status do processo. Enquanto o processo está em execução, uma chamada para o URI no cabeçalho Local retorna um status de 202. Quando o processo é concluído, o URI no cabeçalho Local retorna um status de 204 com êxito. Se a solicitação assíncrona falhar, o URI no cabeçalho Local retornará um código de status no nível de erro.

begin_delete_at_subscription_scope(deployment_name: str, **kwargs: Any) -> LROPoller[None]

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação a ser excluída. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de LROPoller que retorna Nenhum ou o resultado de cls(response)

Tipo de retorno

LROPoller[None]

Exceções

HttpResponseError

calculate_template_hash

Calcule o hash do modelo especificado.

calculate_template_hash(template: MutableMapping[str, Any], **kwargs: Any) -> TemplateHashResult

Parâmetros

template

<xref:JSON>

Obrigatório

O modelo fornecido para calcular o hash. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

TemplateHashResult ou o resultado de cls(response)

Tipo de retorno

TemplateHashResult

Exceções

HttpResponseError

cancel

Cancela uma implantação de modelo em execução no momento.

Você só poderá cancelar uma implantação se o provisioningState for Aceito ou Em Execução. Depois que a implantação é cancelada, o provisioningState é definido como Cancelado. Cancelar uma implantação de modelo para a implantação de modelo atualmente em execução e deixa o grupo de recursos parcialmente implantado.

cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) -> None

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação a ser cancelada. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

cancel_at_subscription_scope

Cancela uma implantação de modelo em execução no momento.

Você só poderá cancelar uma implantação se o provisioningState for Aceito ou Em Execução. Depois que a implantação é cancelada, o provisioningState é definido como Cancelado. O cancelamento de uma implantação de modelo interrompe a implantação de modelo em execução no momento e deixa os recursos parcialmente implantados.

cancel_at_subscription_scope(deployment_name: str, **kwargs: Any) -> None

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação a ser cancelada. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

check_existence

Verifica se a implantação existe.

check_existence(resource_group_name: str, deployment_name: str, **kwargs: Any) -> bool

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos com a implantação para marcar. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação para marcar. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

bool ou o resultado de cls(response)

Tipo de retorno

bool

Exceções

HttpResponseError

check_existence_at_subscription_scope

Verifica se a implantação existe.

check_existence_at_subscription_scope(deployment_name: str, **kwargs: Any) -> bool

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação para marcar. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

bool ou o resultado de cls(response)

Tipo de retorno

bool

Exceções

HttpResponseError

export_template

Exporta o modelo usado para a implantação especificada.

export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação da qual obter o modelo. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentExportResult ou o resultado de cls(response)

Tipo de retorno

DeploymentExportResult

Exceções

HttpResponseError

export_template_at_subscription_scope

Exporta o modelo usado para a implantação especificada.

export_template_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação da qual obter o modelo. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentExportResult ou o resultado de cls(response)

Tipo de retorno

DeploymentExportResult

Exceções

HttpResponseError

get

Obtém uma implantação.

get(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação a ser obtido. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

DeploymentExtended

Exceções

HttpResponseError

get_at_subscription_scope

Obtém uma implantação.

get_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação a ser obtido. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

DeploymentExtended

Exceções

HttpResponseError

list_at_subscription_scope

Obtenha todas as implantações de uma assinatura.

list_at_subscription_scope(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

Parâmetros

filter

str

Obrigatório

O filtro a ser aplicado na operação. Por exemplo, você pode usar $filter=provisioningState eq '{state}'. O valor padrão é Nenhum.

top

int

Obrigatório

O número de resultados a serem obtidos. Se nulo for passado, retornará todas as implantações. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

ItemPaged[DeploymentExtended]

Exceções

HttpResponseError

list_by_resource_group

Obter todas as implantações de um grupo de recursos.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos com as implantações a serem obtidos. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

filter

str

Obrigatório

O filtro a ser aplicado na operação. Por exemplo, você pode usar $filter=provisioningState eq '{state}'. O valor padrão é Nenhum.

top

int

Obrigatório

O número de resultados a serem obtidos. Se nulo for passado, retornará todas as implantações. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de DeploymentExtended ou o resultado de cls(response)

Tipo de retorno

ItemPaged[DeploymentExtended]

Exceções

HttpResponseError

validate

Valida se o modelo especificado está sintaticamente correto e será aceito pelo Azure Resource Manager..

validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos no qual o modelo será implantado. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

deployment_name

str

Obrigatório

O nome da implantação. Obrigatórios.

parameters

Deployment ou IO

Obrigatório

Parâmetros a serem validados. É um tipo de implantação ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentValidateResult ou o resultado de cls(response)

Tipo de retorno

DeploymentValidateResult

Exceções

HttpResponseError

validate_at_subscription_scope

Valida se o modelo especificado está sintaticamente correto e será aceito pelo Azure Resource Manager..

validate_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

Parâmetros

deployment_name

str

Obrigatório

O nome da implantação. Obrigatórios.

parameters

Deployment ou IO

Obrigatório

Parâmetros a serem validados. É um tipo de implantação ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeploymentValidateResult ou o resultado de cls(response)

Tipo de retorno

DeploymentValidateResult

Exceções

HttpResponseError

Atributos

models

models = <module 'azure.mgmt.resource.resources.v2018_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2018_05_01\\models\\__init__.py'>