Deployment Stacks - List At Management Group

Tjänst:: Resource Management

API-versionen:: 2022-08-01-preview

Visar en lista över distributionsstackar i det angivna omfånget.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
managementGroupId	path	True	string minLength: 1	Hanteringsgruppens ID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	DeploymentStackListResult	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

List management group Deployment stacks

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:: 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"
      }
    }
  ]
}

Definitioner

Namn	Beskrivning
ActionOnUnmanage	Definierar beteendet för resurser som inte längre hanteras när stacken har uppdaterats eller tagits bort.
createdByType	Den typ av identitet som skapade resursen.
DenySettings	Definierar hur resurser som distribueras av distributionsstacken är låsta.
DenySettingsMode	denySettings Mode som definierar nekade åtgärder.
DenyStatusMode	nekaTilldelningsinställningar som tillämpas på resursen.
DeploymentParameter	Distributionsparameter för mallen.
DeploymentStack	Distributionsstackens objekt.
DeploymentStackListResult	Svaret från en DeploymentStack-liståtgärd.
DeploymentStackProvisioningState	Distributionsstackens tillstånd.
DeploymentStacksDebugSetting	Felsökningsinställningen.
DeploymentStacksParametersLink	Entitet som representerar referensen till distributionsparametrarna.
DeploymentStacksTemplateLink	Entitet som representerar referensen till mallen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
KeyVaultParameterReference	Parameterreferens för Azure 密钥保管库.
KeyVaultReference	Referens för Azure 密钥保管库.
ManagedResourceReference	Den hanterade resursmodellen.
ResourceReference	ResourceId-modellen.
ResourceReferenceExtended	Den utökade modellen resourceId. Detta används för att dokumentera misslyckade resurser med ett resourceId och ett motsvarande fel.
ResourceStatusMode	Aktuellt hanteringstillstånd för resursen i distributionsstacken.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UnmanageActionManagementGroupMode	Anger en åtgärd för en nyligen ohanterad resurs.
UnmanageActionResourceGroupMode	Specificerar en åtgärd för en nyligen ohanterad resursgrupp.
UnmanageActionResourceMode	Anger en åtgärd för en nyligen ohanterad resurs.

ActionOnUnmanage

Objekt

Definierar beteendet för resurser som inte längre hanteras när stacken har uppdaterats eller tagits bort.

Namn	Typ	Beskrivning
managementGroups	UnmanageActionManagementGroupMode	Specificerar en åtgärd för en nyligen ohanterad resurshanteringsgrupp.
resourceGroups	UnmanageActionResourceGroupMode	Specificerar en åtgärd för en nyligen ohanterad resursgrupp.
resources	UnmanageActionResourceMode	Anger en åtgärd för en nyligen ohanterad resurs.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DenySettings

Objekt

Definierar hur resurser som distribueras av distributionsstacken är låsta.

Namn	Typ	Beskrivning
applyToChildScopes	boolean	DenySettings kommer att tillämpas på underordnade resursomfång för varje hanterad resurs med en tilldelningsnekande.
excludedActions	string[]	Lista över rollbaserade hanteringsåtgärder som undantas från nekaSettings. Upp till 200 åtgärder är tillåtna. Om nekaSetting-läget är inställt på "denyWriteAndDelete" läggs följande åtgärder automatiskt till i "excludedActions": "*/read" och "Microsoft.Authorization/locks/delete". Om nekaSetting-läget är inställt på "denyDelete" läggs följande åtgärder automatiskt till i "excludedActions": "Microsoft.Authorization/locks/delete". Dubblettåtgärder tas bort.
excludedPrincipals	string[]	Lista över AAD-huvudnamns-ID:t som undantas från låset. Upp till 5 huvudkonton är tillåtna.
mode	DenySettingsMode	denySettings Mode som definierar nekade åtgärder.

DenySettingsMode

Uppräkning

denySettings Mode som definierar nekade åtgärder.

Värde	Beskrivning
denyDelete	Behöriga användare kan läsa och ändra resurserna, men kan inte ta bort dem.
denyWriteAndDelete	Behöriga användare kan läsa från en resurs, men kan inte ändra eller ta bort den.
none	Inga nekatilldelningar har tillämpats.

DenyStatusMode

Uppräkning

nekaTilldelningsinställningar som tillämpas på resursen.

Värde	Beskrivning
denyDelete	Behöriga användare kan läsa och ändra resurserna, men kan inte ta bort dem.
notSupported	Resurstypen stöder inte nekaTilldelningar.
inapplicable	nekaTilldelningar stöds inte på resurser utanför distributionsstackens omfång.
denyWriteAndDelete	Behöriga användare kan bara läsa från en resurs, men kan inte ändra eller ta bort den.
removedBySystem	Neka tilldelning har tagits bort av Azure på grund av en resurshanteringsändring (flytt av hanteringsgrupp osv.)
none	Inga nekatilldelningar har tillämpats.

DeploymentParameter

Objekt

Distributionsparameter för mallen.

Namn	Typ	Beskrivning
reference	KeyVaultParameterReference	Parameterreferens för Azure 密钥保管库.
type	string	Typ av värde.
value		Indatavärde till parametern.

DeploymentStack

Objekt

Distributionsstackens objekt.

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Den geografiska plats där resursen finns. Krävs för stackar med omfång för prenumerationer och hanteringsgrupper. Platsen ärvs från resursgruppen för resursgruppsomfångsstackar.
name	string	Namnet på resursen
properties.actionOnUnmanage	ActionOnUnmanage	Definierar beteendet för resurser som inte längre hanteras när distributionsstacken har uppdaterats eller tagits bort.
properties.debugSetting	DeploymentStacksDebugSetting	Felsökningsinställningen för distributionen.
properties.deletedResources	ResourceReference[]	En matris med resurser som togs bort under den senaste uppdateringen av distributionsstacken. Borttagen innebär att resursen har tagits bort från mallen och att relevanta borttagningsåtgärder har angetts.
properties.denySettings	DenySettings	Definierar hur resurser som distribueras av stacken är låsta.
properties.deploymentId	string	ResourceId för distributionsresursen som skapats av distributionsstacken.
properties.deploymentScope	string	Det omfång där den första distributionen ska skapas. Om ett omfång inte har angetts kommer det som standard att vara omfånget för distributionsstacken. Giltiga omfång är: hanteringsgrupp (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), prenumeration (format: '/subscriptions/{subscriptionId}'), resursgrupp (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').
properties.description	string maxLength: 4096	Beskrivning av distributionsstack. Maxlängd på 4096 tecken.
properties.detachedResources	ResourceReference[]	En matris med resurser som kopplades från under den senaste uppdateringen av distributionsstacken. Frånkopplad innebär att resursen har tagits bort från mallen, men inga relevanta borttagningsåtgärder har angetts. Resursen finns alltså fortfarande även om den inte längre är associerad med stacken.
properties.duration	string	Varaktigheten för den senaste lyckade uppdateringen av distributionsstacken.
properties.error	ErrorDetail	Felinformationen.
properties.failedResources	ResourceReferenceExtended[]	En matris med resurser som inte kunde nå måltillståndet under den senaste uppdateringen. Varje resourceId åtföljs av ett felmeddelande.
properties.outputs		Utdata från distributionsresursen som skapats av distributionsstacken.
properties.parameters	<string, DeploymentParameter>	Namn- och värdepar som definierar distributionsparametrarna för mallen. Använd det här elementet när du anger parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.
properties.parametersLink	DeploymentStacksParametersLink	URI:n för parameterfilen. Använd det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.
properties.provisioningState	DeploymentStackProvisioningState	Distributionsstackens tillstånd.
properties.resources	ManagedResourceReference[]	En matris med resurser som för närvarande hanteras av distributionsstacken.
properties.template		Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformulerad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
properties.templateLink	DeploymentStacksTemplateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Objekt

Svaret från en DeploymentStack-liståtgärd.

Namn	Typ	Beskrivning
nextLink	string (uri)	Länken till nästa sida med objekt
value	DeploymentStack[]	DeploymentStack-objekten på den här sidan

DeploymentStackProvisioningState

Uppräkning

Distributionsstackens tillstånd.

Värde	Beskrivning
creating	Distributionsstacken håller på att skapas
validating	Distributionsstacken verifieras för närvarande
waiting	Distributionsstacken väntar för närvarande
deploying	Distributionsstacken distribueras för närvarande
canceling	Distributionsstacken avbryts
updatingDenyAssignments	Distributionsstacken uppdaterar tilldelningsnekanden
deletingResources	Distributionsstacken tar bort resurser
succeeded	Distributionsstacken har slutförts
failed	Distributionsstacken misslyckades
canceled	Distributionsstacken har avbrutits
deleting	Distributionsstacken tas bort

DeploymentStacksDebugSetting

Objekt

Felsökningsinställningen.

Namn	Typ	Beskrivning
detailLevel	string	Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är inga, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är ingen. När du anger det här värdet bör du noga överväga vilken typ av information som skickas under distributionen. Genom att logga information om begäran eller svaret kan känsliga data som hämtas via distributionsåtgärderna potentiellt exponeras.

DeploymentStacksParametersLink

Objekt

Entitet som representerar referensen till distributionsparametrarna.

Namn	Typ	Beskrivning
contentVersion	string	Om det ingår måste det matcha ContentVersion i mallen.
uri	string	URI:n för parameterfilen.

DeploymentStacksTemplateLink

Objekt

Entitet som representerar referensen till mallen.

Namn	Typ	Beskrivning
contentVersion	string	Om det ingår måste det matcha ContentVersion i mallen.
id	string	resourceId för en mallspecifikation. Använd antingen egenskapen id eller uri, men inte båda.
queryString	string	Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n.
relativePath	string	Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar den till en artefakt i TemplateSpec. Om den överordnade versionen var länkad till en URI är den underordnade distributionen en kombination av de överordnade URI:erna och relativePath.
uri	string	URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

KeyVaultParameterReference

Objekt

Parameterreferens för Azure 密钥保管库.

Namn	Typ	Beskrivning
keyVault	KeyVaultReference	Referens för Azure 密钥保管库.
secretName	string	Azure 密钥保管库 hemligt namn.
secretVersion	string	Azure 密钥保管库 hemlig version.

KeyVaultReference

Objekt

Referens för Azure 密钥保管库.

Namn	Typ	Beskrivning
id	string	Azure 密钥保管库 resourceId.

ManagedResourceReference

Objekt

Den hanterade resursmodellen.

Namn	Typ	Standardvärde	Beskrivning
denyStatus	DenyStatusMode	none	nekaTilldelningsinställningar som tillämpas på resursen.
id	string		ARM-resurs-ID:t för en resurs som hanteras av distributionsstacken.
status	ResourceStatusMode	none	Aktuellt hanteringstillstånd för resursen i distributionsstacken.

ResourceReference

Objekt

ResourceId-modellen.

Namn	Typ	Beskrivning
id	string	ARM-resurs-ID:t för en resurs som hanteras av distributionsstacken.

ResourceReferenceExtended

Objekt

Den utökade modellen resourceId. Detta används för att dokumentera misslyckade resurser med ett resourceId och ett motsvarande fel.

Namn	Typ	Beskrivning
error	ErrorDetail	Felinformationen.
id	string	ARM-resurs-ID:t för en resurs som hanteras av distributionsstacken.

ResourceStatusMode

Uppräkning

Aktuellt hanteringstillstånd för resursen i distributionsstacken.

Värde	Beskrivning
managed	Den här resursen hanteras av distributionsstacken.
removeDenyFailed	Det går inte att ta bort neka-tilldelningen för resursen.
deleteFailed	Det går inte att ta bort resursen från Azure. Borttagningen görs på nytt vid nästa stackdistribution eller kan tas bort manuellt.
none	Inget hanteringstillstånd.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UnmanageActionManagementGroupMode

Uppräkning

Anger en åtgärd för en nyligen ohanterad resurs.

Värde	Beskrivning
delete	Ta bort hanteringsgrupperna från Azure.
detach	Behåll ledningsgrupperna i Azure.

UnmanageActionResourceGroupMode

Uppräkning

Specificerar en åtgärd för en nyligen ohanterad resursgrupp.

Värde	Beskrivning
delete	Ta bort resursgrupperna från Azure.
detach	Behåll resursgrupperna i Azure.

UnmanageActionResourceMode

Uppräkning

Anger en åtgärd för en nyligen ohanterad resurs.

Värde	Beskrivning
delete	Ta bort resurserna från Azure
detach	Behåll resurserna i Azure

Dela via

Deployment Stacks - List At Management Group

URI-parametrar

Svaren

Säkerhet

azure_auth

Scope

Exempel

List management group Deployment stacks

Exempelförfrågan

Exempelsvar

Definitioner

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