Deployment Stacks - List At Management Group

Serviço:

Resource Management

Versão da API:

2022-08-01-preview

Lista as pilhas de implantação no escopo 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	A ID do 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	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

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 sua conta de usuário

Exemplos

List management group Deployment stacks

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 mais gerenciados depois que a pilha é atualizada ou excluída.
createdByType	O tipo de identidade que criou o recurso.
DenySettings	Define como os recursos implantados pela pilha de implantação são bloqueados.
DenySettingsMode	denySettings Modo que define ações negadas.
DenyStatusMode	Configurações denyAssignment aplicadas ao recurso.
DeploymentParameter	Parâmetro de implantação para o modelo.
DeploymentStack	Objeto de pilha de implantação.
DeploymentStackListResult	A resposta de uma operação de lista DeploymentStack.
DeploymentStackProvisioningState	Estado da pilha de implantação.
DeploymentStacksDebugSetting	A configuração de depuração.
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
KeyVaultParameterReference	Referência de parâmetro do Azure Key Vault.
KeyVaultReference	Referência do Azure Key Vault.
ManagedResourceReference	O modelo de recurso gerenciado.
ResourceReference	O modelo resourceId.
ResourceReferenceExtended	O modelo estendido resourceId. Isso é usado para documentar recursos com falha com um resourceId e um erro correspondente.
ResourceStatusMode	Estado de gerenciamento atual do recurso na pilha de implantação.
systemData	Metadados relativos à criação e última modificação do recurso.
UnmanageActionManagementGroupMode	Especifica uma ação para um recurso recém-não gerenciado.
UnmanageActionResourceGroupMode	Especifica uma ação para um grupo de recursos recém-não gerenciado.
UnmanageActionResourceMode	Especifica uma ação para um recurso recém-não gerenciado.

ActionOnUnmanage

Objeto

Define o comportamento dos recursos que não são mais gerenciados depois que a pilha é atualizada ou excluída.

Nome	Tipo	Description
managementGroups	UnmanageActionManagementGroupMode	Especifica uma ação para um grupo de gerenciamento de recursos recém-não gerenciado.
resourceGroups	UnmanageActionResourceGroupMode	Especifica uma ação para um grupo de recursos recém-não gerenciado.
resources	UnmanageActionResourceMode	Especifica uma ação para um recurso recém-não gerenciado.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

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 de recursos filho de cada recurso gerenciado com uma atribuição de negação.
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	denySettings Modo que define ações negadas.

DenySettingsMode

Enumeração

denySettings Modo que define ações negadas.

Valor	Description
denyDelete	Os usuários autorizados podem ler e modificar os recursos, mas não podem excluir.
denyWriteAndDelete	Os usuários autorizados 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
denyDelete	Os usuários autorizados podem ler e modificar os recursos, mas não podem excluir.
notSupported	O tipo de recurso não dá suporte a denyAssignments.
inapplicable	DenyAssignments não têm suporte em recursos fora do escopo da pilha de implantação.
denyWriteAndDelete	Os usuários autorizados só podem ler de um recurso, mas não podem modificá-lo ou excluí-lo.
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.)
none	Nenhum denyAssignments foi aplicado.

DeploymentParameter

Objeto

Parâmetro de implantação para o modelo.

Nome	Tipo	Description
reference	KeyVaultParameterReference	Referência de parâmetro do Azure Key Vault.
type	string	Tipo do valor.
value		Insira o valor para o parâmetro.

DeploymentStack

Objeto

Objeto de pilha de implantação.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside. Necessário para pilhas no escopo do grupo de gerenciamento e assinatura. O local é herdado do grupo de recursos para pilhas no escopo do grupo de recursos.
name	string	O nome do recurso
properties.actionOnUnmanage	ActionOnUnmanage	Define o comportamento dos recursos que não são mais gerenciados depois que a pilha de implantação é atualizada ou excluída.
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 da pilha de implantação. Excluído significa que o recurso foi removido do modelo e as operações de exclusão relevantes foram especificadas.
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. Comprimento máximo de 4096 caracteres.
properties.detachedResources	ResourceReference[]	Uma matriz de recursos que foram desanexados durante a atualização mais recente da pilha de implantação. Desanexado significa que o recurso foi removido do modelo, mas nenhuma operação de exclusão relevante foi especificada. Portanto, o recurso ainda existe enquanto não está mais associado à pilha.
properties.duration	string	A duração da última atualização bem-sucedida da pilha de implantação.
properties.error	ErrorDetail	O detalhe do erro.
properties.failedResources	ResourceReferenceExtended[]	Uma matriz de recursos que não atingiu o estado de meta durante a atualização mais recente. Cada resourceId é acompanhado por uma mensagem de erro.
properties.outputs		As saídas do recurso de implantação criado pela pilha de implantação.
properties.parameters	<string,  DeploymentParameter>	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.
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		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	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Objeto

A resposta de uma operação de lista DeploymentStack.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	DeploymentStack[]	Os itens DeploymentStack nesta página

DeploymentStackProvisioningState

Enumeração

Estado da pilha de implantação.

Valor	Description
creating	A pilha de implantação está sendo criada no momento
validating	A pilha de implantação está sendo validada no momento
waiting	A pilha de implantação está aguardando no momento
deploying	A pilha de implantação está sendo implantada no momento
canceling	A pilha de implantação está sendo cancelada
updatingDenyAssignments	A pilha de implantação está atualizando atribuições de negação
deletingResources	A pilha de implantação está excluindo recursos
succeeded	A pilha de implantação foi concluída com êxito
failed	A pilha de implantação falhou
canceled	A pilha de implantação foi cancelada
deleting	A pilha de implantação está sendo excluída

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.

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	O resourceId 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 tiver sido vinculado a um URI, a implantação filho será uma combinação dos 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.

KeyVaultParameterReference

Objeto

Referência de parâmetro do Azure Key Vault.

Nome	Tipo	Description
keyVault	KeyVaultReference	Referência do Azure Key Vault.
secretName	string	Nome secreto do Azure Key Vault.
secretVersion	string	Versão secreta do Azure Key Vault.

KeyVaultReference

Objeto

Referência do Azure Key Vault.

Nome	Tipo	Description
id	string	ResourceId do Azure Key Vault.

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 ID do recurso do ARM 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 resourceId.

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

ResourceReferenceExtended

Objeto

O modelo estendido resourceId. Isso é usado para documentar recursos com falha com um resourceId e um erro correspondente.

Nome	Tipo	Description
error	ErrorDetail	O detalhe do erro.
id	string	A ID do recurso do ARM 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.
removeDenyFailed	Não é possível remover a atribuição de negação no recurso.
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.
none	Sem estado de gerenciamento.

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.

UnmanageActionManagementGroupMode

Enumeração

Especifica uma ação para um recurso recém-não gerenciado.

Valor	Description
delete	Exclua os grupos de gerenciamento do Azure.
detach	Mantenha os grupos de gerenciamento no Azure.

UnmanageActionResourceGroupMode

Enumeração

Especifica uma ação para um grupo de recursos recém-não gerenciado.

Valor	Description
delete	Exclua os grupos de recursos do Azure.
detach	Mantenha os grupos de recursos no Azure.

UnmanageActionResourceMode

Enumeração

Especifica uma ação para um recurso recém-não gerenciado.

Valor	Description
delete	Exclua os recursos do Azure
detach	Mantenha os recursos no Azure