Deployment Stacks - List At Management Group

Servizio:: Resource Management

Versione API:: 2022-08-01-preview

Elenca gli stack di distribuzione nell'ambito specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
managementGroupId	path	True	string minLength: 1	ID del gruppo di gestione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	DeploymentStackListResult	L'operazione di Azure è stata completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List management group Deployment stacks

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ActionOnUnmanage	Definisce il comportamento delle risorse che non vengono più gestite dopo l'aggiornamento o l'eliminazione dello stack.
createdByType	Tipo di identità che ha creato la risorsa.
DenySettings	Definisce la modalità di blocco delle risorse distribuite dallo stack di distribuzione.
DenySettingsMode	denySettings Modalità che definisce le azioni negate.
DenyStatusMode	denyAssignment impostazioni applicate alla risorsa.
DeploymentParameter	Parametro di distribuzione per il modello.
DeploymentStack	Oggetto stack di distribuzione.
DeploymentStackListResult	Risposta di un'operazione di elenco DeploymentStack.
DeploymentStackProvisioningState	Stato dello stack di distribuzione.
DeploymentStacksDebugSetting	Impostazione di debug.
DeploymentStacksParametersLink	Entità che rappresenta il riferimento ai parametri di distribuzione.
DeploymentStacksTemplateLink	Entità che rappresenta il riferimento al modello.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
KeyVaultParameterReference	Informazioni di riferimento sui parametri di Azure Key Vault.
KeyVaultReference	Informazioni di riferimento su Azure Key Vault.
ManagedResourceReference	Modello di risorse gestite.
ResourceReference	Modello resourceId.
ResourceReferenceExtended	Modello esteso resourceId. Viene utilizzato per documentare le risorse non riuscite con un resourceId e un errore corrispondente.
ResourceStatusMode	Stato di gestione corrente della risorsa nello stack di distribuzione.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UnmanageActionManagementGroupMode	Specifica un'azione per una risorsa non gestita di recente.
UnmanageActionResourceGroupMode	Specifica un'azione per un gruppo di risorse appena non gestito.
UnmanageActionResourceMode	Specifica un'azione per una risorsa non gestita di recente.

ActionOnUnmanage

Oggetto

Definisce il comportamento delle risorse che non vengono più gestite dopo l'aggiornamento o l'eliminazione dello stack.

Nome	Tipo	Descrizione
managementGroups	UnmanageActionManagementGroupMode	Specifica un'azione per un gruppo di gestione delle risorse non gestito di nuova data.
resourceGroups	UnmanageActionResourceGroupMode	Specifica un'azione per un gruppo di risorse appena non gestito.
resources	UnmanageActionResourceMode	Specifica un'azione per una risorsa non gestita di recente.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DenySettings

Oggetto

Definisce la modalità di blocco delle risorse distribuite dallo stack di distribuzione.

Nome	Tipo	Descrizione
applyToChildScopes	boolean	DenySettings verrà applicato agli ambiti delle risorse figlio di ogni risorsa gestita con un'assegnazione di negazione.
excludedActions	string[]	Elenco delle operazioni di gestione basate sui ruoli escluse da denySettings. Sono consentite fino a 200 azioni. Se la modalità denySetting è impostata su 'denyWriteAndDelete', le azioni seguenti vengono aggiunte automaticamente a 'excludedActions': '*/read' e 'Microsoft.Authorization/locks/delete'. Se la modalità denySetting è impostata su 'denyDelete', le azioni seguenti vengono aggiunte automaticamente a 'excludedActions': 'Microsoft.Authorization/locks/delete'. Le azioni duplicate verranno rimosse.
excludedPrincipals	string[]	Elenco degli ID entità di AAD esclusi dal blocco. Sono consentite fino a 5 entità.
mode	DenySettingsMode	denySettings Modalità che definisce le azioni negate.

DenySettingsMode

Enumerazione

denySettings Modalità che definisce le azioni negate.

Valore	Descrizione
denyDelete	Gli utenti autorizzati possono leggere e modificare le risorse, ma non possono eliminarle.
denyWriteAndDelete	Gli utenti autorizzati possono leggere da una risorsa, ma non possono modificarla o eliminarla.
none	Nessuna negazioneAssignments è stata applicata.

DenyStatusMode

Enumerazione

denyAssignment impostazioni applicate alla risorsa.

Valore	Descrizione
denyDelete	Gli utenti autorizzati possono leggere e modificare le risorse, ma non possono eliminarle.
notSupported	Il tipo di risorsa non supporta denyAssignments.
inapplicable	denyAssignments non è supportato nelle risorse esterne all'ambito dello stack di distribuzione.
denyWriteAndDelete	Gli utenti autorizzati possono leggere solo da una risorsa, ma non possono modificarla o eliminarla.
removedBySystem	L'assegnazione di rifiuto è stata rimossa da Azure a causa di una modifica della gestione delle risorse (spostamento del gruppo di gestione e così via)
none	Nessuna negazioneAssignments è stata applicata.

DeploymentParameter

Oggetto

Parametro di distribuzione per il modello.

Nome	Tipo	Descrizione
reference	KeyVaultParameterReference	Informazioni di riferimento sui parametri di Azure Key Vault.
type	string	Tipo del valore.
value		Valore di input per il parametro.

DeploymentStack

Oggetto

Oggetto stack di distribuzione.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	La geolocalizzazione in cui risiede la risorsa. Obbligatorio per gli stack con ambito sottoscrizione e gruppo di gestione. La posizione viene ereditata dal gruppo di risorse per gli stack con ambito del gruppo di risorse.
name	string	Nome della risorsa
properties.actionOnUnmanage	ActionOnUnmanage	Definisce il comportamento delle risorse che non sono più gestite dopo l'aggiornamento o l'eliminazione dello stack di distribuzione.
properties.debugSetting	DeploymentStacksDebugSetting	Impostazione di debug della distribuzione.
properties.deletedResources	ResourceReference[]	Una matrice di risorse che sono state eliminate durante l'aggiornamento più recente dello stack di distribuzione. Eliminato significa che la risorsa è stata rimossa dal modello e sono state specificate le operazioni di eliminazione pertinenti.
properties.denySettings	DenySettings	Definisce la modalità di blocco delle risorse distribuite dallo stack.
properties.deploymentId	string	ResourceId della risorsa di distribuzione creata dallo stack di distribuzione.
properties.deploymentScope	string	Ambito in cui deve essere creata la distribuzione iniziale. Se non viene specificato un ambito, per impostazione predefinita verrà impostato l'ambito dello stack di distribuzione. Gli ambiti validi sono: gruppo di gestione (formato: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), sottoscrizione (formato: '/subscriptions/{subscriptionId}'), gruppo di risorse (formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
properties.description	string maxLength: 4096	Descrizione dello stack di distribuzione. Lunghezza massima di 4096 caratteri.
properties.detachedResources	ResourceReference[]	Matrice di risorse scollegate durante l'aggiornamento più recente dello stack di distribuzione. Dissociato significa che la risorsa è stata rimossa dal modello, ma non sono state specificate operazioni di eliminazione pertinenti. Pertanto, la risorsa esiste ancora senza essere più associata allo stack.
properties.duration	string	Durata dell'ultimo aggiornamento dello stack di distribuzione riuscito.
properties.error	ErrorDetail	Dettagli dell'errore.
properties.failedResources	ResourceReferenceExtended[]	Matrice di risorse che non sono riuscite a raggiungere lo stato obiettivo durante l'aggiornamento più recente. Ogni resourceId è accompagnato da un messaggio di errore.
properties.outputs		Gli output della risorsa di distribuzione creata dallo stack di distribuzione.
properties.parameters	<string, DeploymentParameter>	Coppie nome e valore che definiscono i parametri di distribuzione per il modello. Usare questo elemento quando si specificano i valori dei parametri direttamente nella richiesta, anziché collegarsi a un file di parametri esistente. Utilizzare la proprietà parametersLink o la proprietà parameters, ma non entrambe.
properties.parametersLink	DeploymentStacksParametersLink	URI del file di parametri. Utilizzare questo elemento per collegarsi a un file di parametri esistente. Utilizzare la proprietà parametersLink o la proprietà parameters, ma non entrambe.
properties.provisioningState	DeploymentStackProvisioningState	Stato dello stack di distribuzione.
properties.resources	ManagedResourceReference[]	Matrice di risorse attualmente gestite dallo stack di distribuzione.
properties.template		Contenuto del modello. Questo elemento viene usato quando si vuole passare la sintassi del modello direttamente nella richiesta anziché collegarsi a un modello esistente. Può trattarsi di una stringa JSON JObject o di formato corretto. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.
properties.templateLink	DeploymentStacksTemplateLink	URI del modello. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Oggetto

Risposta di un'operazione di elenco DeploymentStack.

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	DeploymentStack[]	Gli elementi DeploymentStack in questa pagina

DeploymentStackProvisioningState

Enumerazione

Stato dello stack di distribuzione.

Valore	Descrizione
creating	Lo stack di distribuzione è attualmente in fase di creazione
validating	Lo stack di distribuzione è attualmente in fase di convalida
waiting	Lo stack di distribuzione è attualmente in attesa
deploying	Lo stack di distribuzione è attualmente in fase di distribuzione
canceling	Lo stack di distribuzione è in corso l'annullamento
updatingDenyAssignments	Lo stack di distribuzione sta aggiornando le assegnazioni di rifiuto
deletingResources	Lo stack di distribuzione sta eliminando le risorse
succeeded	Lo stack di distribuzione è stato completato correttamente
failed	Lo stack di distribuzione non è riuscito
canceled	Lo stack di distribuzione è stato annullato
deleting	Lo stack di distribuzione è in corso l'eliminazione

DeploymentStacksDebugSetting

Oggetto

Impostazione di debug.

Nome	Tipo	Descrizione
detailLevel	string	Specifica il tipo di informazioni da registrare per il debug. I valori consentiti sono none, requestContent, responseContent o requestContent e responseContent separati da una virgola. Il valore predefinito è nessuno. Quando si imposta questo valore, considerare attentamente il tipo di informazioni passate durante la distribuzione. Registrando informazioni sulla richiesta o sulla risposta, i dati sensibili recuperati tramite le operazioni di distribuzione potrebbero essere potenzialmente esposti.

DeploymentStacksParametersLink

Oggetto

Entità che rappresenta il riferimento ai parametri di distribuzione.

Nome	Tipo	Descrizione
contentVersion	string	Se incluso, deve corrispondere a ContentVersion nel modello.
uri	string	URI del file di parametri.

DeploymentStacksTemplateLink

Oggetto

Entità che rappresenta il riferimento al modello.

Nome	Tipo	Descrizione
contentVersion	string	Se incluso, deve corrispondere a ContentVersion nel modello.
id	string	ResourceId di una specifica di modello. Utilizzare la proprietà id o uri, ma non entrambe.
queryString	string	Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink.
relativePath	string	La proprietà relativePath può essere utilizzata per distribuire un modello collegato in una posizione relativa all'elemento padre. Se il modello padre è stato collegato a un oggetto TemplateSpec, verrà fatto riferimento a un artefatto in TemplateSpec. Se l'elemento padre è stato collegato a un URI, la distribuzione figlio sarà una combinazione degli URI padre e relativePath.
uri	string	URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

KeyVaultParameterReference

Oggetto

Informazioni di riferimento sui parametri di Azure Key Vault.

Nome	Tipo	Descrizione
keyVault	KeyVaultReference	Informazioni di riferimento su Azure Key Vault.
secretName	string	Nome segreto di Azure Key Vault.
secretVersion	string	Versione segreta di Azure Key Vault.

KeyVaultReference

Oggetto

Informazioni di riferimento su Azure Key Vault.

Nome	Tipo	Descrizione
id	string	ResourceId dell'insieme di credenziali delle chiavi di Azure.

ManagedResourceReference

Oggetto

Modello di risorse gestite.

Nome	Tipo	Valore predefinito	Descrizione
denyStatus	DenyStatusMode	none	denyAssignment impostazioni applicate alla risorsa.
id	string		ID risorsa ARM di una risorsa gestita dallo stack di distribuzione.
status	ResourceStatusMode	none	Stato di gestione corrente della risorsa nello stack di distribuzione.

ResourceReference

Oggetto

Modello resourceId.

Nome	Tipo	Descrizione
id	string	ID risorsa ARM di una risorsa gestita dallo stack di distribuzione.

ResourceReferenceExtended

Oggetto

Modello esteso resourceId. Viene utilizzato per documentare le risorse non riuscite con un resourceId e un errore corrispondente.

Nome	Tipo	Descrizione
error	ErrorDetail	Dettagli dell'errore.
id	string	ID risorsa ARM di una risorsa gestita dallo stack di distribuzione.

ResourceStatusMode

Enumerazione

Stato di gestione corrente della risorsa nello stack di distribuzione.

Valore	Descrizione
managed	Questa risorsa viene gestita dallo stack di distribuzione.
removeDenyFailed	Impossibile rimuovere l'assegnazione di rifiuto nella risorsa.
deleteFailed	Impossibile eliminare la risorsa da Azure. L'eliminazione verrà ritentata nella successiva distribuzione dello stack o può essere eliminata manualmente.
none	Nessuno stato di gestione.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UnmanageActionManagementGroupMode

Enumerazione

Specifica un'azione per una risorsa non gestita di recente.

Valore	Descrizione
delete	Elimina i gruppi di gestione da Azure.
detach	Tieni i gruppi di gestione in Azure.

UnmanageActionResourceGroupMode

Enumerazione

Specifica un'azione per un gruppo di risorse appena non gestito.

Valore	Descrizione
delete	Elimina i gruppi di risorse da Azure.
detach	Tieni i gruppi di risorse in Azure.

UnmanageActionResourceMode

Enumerazione

Specifica un'azione per una risorsa non gestita di recente.

Valore	Descrizione
delete	Elimina le risorse da Azure
detach	Tieni le risorse in Azure

Condividi tramite

Deployment Stacks - List At Management Group

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List management group Deployment stacks

Esempio di richiesta

Risposta di esempio

Definizioni

ActionOnUnmanage

createdByType

DenySettings

DenySettingsMode

DenyStatusMode

DeploymentParameter

DeploymentStack

DeploymentStackListResult

DeploymentStackProvisioningState

DeploymentStacksDebugSetting

DeploymentStacksParametersLink

DeploymentStacksTemplateLink

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultParameterReference

KeyVaultReference

ManagedResourceReference

ResourceReference

ResourceReferenceExtended

ResourceStatusMode

systemData

UnmanageActionManagementGroupMode

UnmanageActionResourceGroupMode

UnmanageActionResourceMode