Deployment Stacks - List At Management Group

Serviço:: Resource Management

Versão da API:: 2022-08-01-preview

Lista todas as Pilhas de Implantação dentro do grupo de gerenciamento especificado.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks?api-version=2022-08-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
managementGroupId	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Grupo de Gerenciamento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	DeploymentStackListResult	OK - Retorna uma matriz de Pilhas de Implantação.
Other Status Codes	DeploymentStacksError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar conta de usuário

Exemplos

DeploymentStacksList

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks?api-version=2022-08-01-preview

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack",
      "type": "Microsoft.Resources/deploymentStacks",
      "name": "simpleDeploymentStack",
      "location": "eastus",
      "tags": {
        "tagkey": "tagVal"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
      },
      "properties": {
        "actionOnUnmanage": {
          "resources": "delete",
          "resourceGroups": "delete",
          "managementGroups": "detach"
        },
        "denySettings": {
          "mode": "denyDelete",
          "excludedPrincipals": [
            "principal"
          ],
          "excludedActions": [
            "action"
          ],
          "applyToChildScopes": false
        },
        "parameters": {
          "parameter1": {
            "value": "a string"
          }
        },
        "outputs": {
          "myOut": "myVal"
        },
        "duration": "PT1D12H"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack2",
      "type": "Microsoft.Resources/deploymentStacks",
      "name": "simpleDeploymentStack2",
      "location": "eastus",
      "tags": {
        "tagkey": "tagVal"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
      },
      "properties": {
        "deploymentId": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deployments/simpleDeploymentStack2-20210301-3f41c",
        "provisioningState": "SucceededWithFailures",
        "resources": [
          {
            "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/templateSpecs/templateSpec/versions/1.0",
            "status": "Managed",
            "denyStatus": "denyDelete"
          },
          {
            "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
            "status": "Managed",
            "denyStatus": "denyDelete"
          }
        ],
        "actionOnUnmanage": {
          "resources": "delete",
          "resourceGroups": "delete",
          "managementGroups": "detach"
        },
        "denySettings": {
          "mode": "denyDelete",
          "excludedPrincipals": [
            "principal"
          ],
          "excludedActions": [
            "action"
          ],
          "applyToChildScopes": false
        },
        "parameters": {
          "parameter1": {
            "value": "a string"
          }
        },
        "outputs": {
          "myOut": "myVal"
        },
        "duration": "PT1D12H"
      }
    }
  ]
}

Definições

Nome	Description
ActionOnUnmanage	Define o comportamento dos recursos que não são gerenciados imediatamente após a atualização da pilha.
createdByType	O tipo de identidade que criou o recurso.
DenySettings	Define como os recursos implantados pela pilha de implantação são bloqueados.
DenySettingsMode	Modo denySettings.
DenyStatusMode	Configurações denyAssignment aplicadas ao recurso.
DeploymentStack	Objeto de pilha de implantação.
DeploymentStackListResult	Lista de pilhas de implantação.
DeploymentStackProvisioningState	Estado da pilha de implantação.
DeploymentStacksDebugSetting	A configuração de depuração.
DeploymentStacksDeleteDetachEnum	Especifica a ação que deve ser executada no recurso quando a pilha de implantação é excluída. Excluir tentará excluir o recurso do Azure. Desanexar deixará o recurso no estado atual.
DeploymentStacksError	Resposta de erro do Deployment Stacks.
DeploymentStacksParametersLink	Entidade que representa a referência aos parâmetros de implantação.
DeploymentStacksTemplateLink	Entidade que representa a referência ao modelo.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedResourceReference	O modelo de recurso gerenciado.
ResourceReference	O modelo de ID do recurso.
ResourceReferenceExtended	O modelo estendido da ID do recurso.
ResourceStatusMode	Estado de gerenciamento atual do recurso na pilha de implantação.
systemData	Metadados relativos à criação e última modificação do recurso.

ActionOnUnmanage

Objeto

Define o comportamento dos recursos que não são gerenciados imediatamente após a atualização da pilha.

Nome	Tipo	Description
managementGroups	DeploymentStacksDeleteDetachEnum	Especifica a ação que deve ser executada no recurso quando a pilha de implantação é excluída. Excluir tentará excluir o recurso do Azure. Desanexar deixará o recurso no estado atual.
resourceGroups	DeploymentStacksDeleteDetachEnum	Especifica a ação que deve ser executada no recurso quando a pilha de implantação é excluída. Excluir tentará excluir o recurso do Azure. Desanexar deixará o recurso no estado atual.
resources	DeploymentStacksDeleteDetachEnum	Especifica a ação que deve ser executada no recurso quando a pilha de implantação é excluída. Excluir tentará excluir o recurso do Azure. Desanexar deixará o recurso no estado atual.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DenySettings

Objeto

Define como os recursos implantados pela pilha de implantação são bloqueados.

Nome	Tipo	Description
applyToChildScopes	boolean	DenySettings será aplicado a escopos filho.
excludedActions	string[]	Lista de operações de gerenciamento baseadas em função que são excluídas das denySettings. Até 200 ações são permitidas. Se o modo denySetting estiver definido como 'denyWriteAndDelete', as seguintes ações serão acrescentadas automaticamente a 'excludedActions': '*/read' e 'Microsoft.Authorization/locks/delete'. Se o modo denySetting estiver definido como 'denyDelete', as seguintes ações serão acrescentadas automaticamente a 'excludedActions': 'Microsoft.Authorization/locks/delete'. Ações duplicadas serão removidas.
excludedPrincipals	string[]	Lista de IDs de entidade de segurança do AAD excluídas do bloqueio. Até 5 entidades de segurança são permitidas.
mode	DenySettingsMode	Modo denySettings.

DenySettingsMode

Enumeração

Modo denySettings.

Valor	Description
denyDelete	Os usuários autorizados podem ler e modificar os recursos, mas não podem excluir.
denyWriteAndDelete	Os usuários autorizados só podem ler de um recurso, mas não podem modificá-lo ou excluí-lo.
none	Nenhum denyAssignments foi aplicado.

DenyStatusMode

Enumeração

Configurações denyAssignment aplicadas ao recurso.

Valor	Description
None	Nenhum denyAssignments foi aplicado.
denyDelete	Os usuários autorizados podem ler e modificar os recursos, mas não podem excluir.
denyWriteAndDelete	Os usuários autorizados só podem ler de um recurso, mas não podem modificá-lo ou excluí-lo.
inapplicable	DenyAssignments não têm suporte em recursos fora do escopo da pilha de implantação.
notSupported	O tipo de recurso não dá suporte a denyAssignments.
removedBySystem	A atribuição de negação foi removida pelo Azure devido a uma alteração de gerenciamento de recursos (movimentação de grupo de gerenciamento etc.)

DeploymentStack

Objeto

Objeto de pilha de implantação.

Nome	Tipo	Description
id	string	ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
location	string	O local da pilha de implantação. Ele não pode ser alterado após a criação. Ele deve ser um dos locais do Azure com suporte.
name	string	Nome desse recurso.
properties.actionOnUnmanage	ActionOnUnmanage	Define o comportamento dos recursos que não são gerenciados imediatamente após a atualização da pilha.
properties.debugSetting	DeploymentStacksDebugSetting	A configuração de depuração da implantação.
properties.deletedResources	ResourceReference[]	Uma matriz de recursos que foram excluídos durante a atualização mais recente.
properties.denySettings	DenySettings	Define como os recursos implantados pela pilha são bloqueados.
properties.deploymentId	string	A resourceId do recurso de implantação criado pela pilha de implantação.
properties.deploymentScope	string	O escopo no qual a implantação inicial deve ser criada. Se um escopo não for especificado, ele usará como padrão o escopo da pilha de implantação. Os escopos válidos são: grupo de gerenciamento (formato: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), assinatura (formato: '/subscriptions/{subscriptionId}'), grupo de recursos (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
properties.description	string maxLength: 4096	Descrição da pilha de implantação.
properties.detachedResources	ResourceReference[]	Uma matriz de recursos que foram desanexados durante a atualização mais recente.
properties.duration	string	A duração da atualização da pilha de implantação.
properties.error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
properties.failedResources	ResourceReferenceExtended[]	Uma matriz de recursos que não atingiu o estado de meta durante a atualização mais recente.
properties.outputs	object	As saídas da implantação subjacente.
properties.parameters	object	Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento ao fornecer os valores de parâmetro diretamente na solicitação, em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada.
properties.parametersLink	DeploymentStacksParametersLink	O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos.
properties.provisioningState	DeploymentStackProvisioningState	Estado da pilha de implantação.
properties.resources	ManagedResourceReference[]	Uma matriz de recursos atualmente gerenciada pela pilha de implantação.
properties.template	object	O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JObject ou JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.
properties.templateLink	DeploymentStacksTemplateLink	O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Marcas de recurso de pilha de implantação.
type	string	Tipo desse recurso.

DeploymentStackListResult

Objeto

Lista de pilhas de implantação.

Nome	Tipo	Description
nextLink	string	A URL a ser usada para obter o próximo conjunto de resultados.
value	DeploymentStack[]	Uma matriz de pilhas de implantação.

DeploymentStackProvisioningState

Enumeração

Estado da pilha de implantação.

Valor	Description
Canceled
Canceling
Creating
Deleting
DeletingResources
Deploying
Failed
Locking
Succeeded
Validating
Waiting

DeploymentStacksDebugSetting

Objeto

A configuração de depuração.

Nome	Tipo	Description
detailLevel	string	Especifica o tipo de informação a ser registrada em log para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que está sendo passada durante a implantação. Ao registrar em log informações sobre a solicitação ou resposta, os dados confidenciais recuperados por meio das operações de implantação podem ser potencialmente expostos.

DeploymentStacksDeleteDetachEnum

Enumeração

Especifica a ação que deve ser executada no recurso quando a pilha de implantação é excluída. Excluir tentará excluir o recurso do Azure. Desanexar deixará o recurso no estado atual.

Valor	Description
delete
detach

DeploymentStacksError

Objeto

Resposta de erro do Deployment Stacks.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

DeploymentStacksParametersLink

Objeto

Entidade que representa a referência aos parâmetros de implantação.

Nome	Tipo	Description
contentVersion	string	Se incluído, deverá corresponder ao ContentVersion no modelo.
uri	string	O URI do arquivo de parâmetros.

DeploymentStacksTemplateLink

Objeto

Entidade que representa a referência ao modelo.

Nome	Tipo	Description
contentVersion	string	Se incluído, deverá corresponder ao ContentVersion no modelo.
id	string	A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas.
queryString	string	A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink.
relativePath	string	A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai estiver vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai estiver vinculado a um URI, a implantação filho será uma combinação das URIs pai e relativePath
uri	string	O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedResourceReference

Objeto

O modelo de recurso gerenciado.

Nome	Tipo	Valor padrão	Description
denyStatus	DenyStatusMode	None	Configurações denyAssignment aplicadas ao recurso.
id	string		A resourceId de um recurso gerenciado pela pilha de implantação.
status	ResourceStatusMode	None	Estado de gerenciamento atual do recurso na pilha de implantação.

ResourceReference

Objeto

O modelo de ID do recurso.

Nome	Tipo	Description
id	string	A resourceId de um recurso gerenciado pela pilha de implantação.

ResourceReferenceExtended

Objeto

O modelo estendido da ID do recurso.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
id	string	A resourceId de um recurso gerenciado pela pilha de implantação.

ResourceStatusMode

Enumeração

Estado de gerenciamento atual do recurso na pilha de implantação.

Valor	Description
Managed	Esse recurso é gerenciado pela pilha de implantação.
None	Nenhum denyAssignments foi aplicado.
deleteFailed	Não é possível excluir o recurso do Azure. A exclusão será repetida na próxima implantação de pilha ou poderá ser excluída manualmente.
removeDenyFailed	Não é possível remover a atribuição de negação no recurso.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Deployment Stacks - List At Management Group

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

DeploymentStacksList

Solicitação de exemplo

Resposta de exemplo

Definições

ActionOnUnmanage

createdByType

DenySettings

DenySettingsMode

DenyStatusMode

DeploymentStack

DeploymentStackListResult

DeploymentStackProvisioningState

DeploymentStacksDebugSetting

DeploymentStacksDeleteDetachEnum

DeploymentStacksError

DeploymentStacksParametersLink

DeploymentStacksTemplateLink

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedResourceReference

ResourceReference

ResourceReferenceExtended

ResourceStatusMode

systemData