Delen via


Deployment Stacks - List At Management Group

Een lijst met alle implementatiestacks binnen de opgegeven beheergroep.

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

URI-parameters

Name In Vereist Type Description
managementGroupId
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Beheergroep.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

DeploymentStackListResult

OK: retourneert een matrix met implementatiestacks.

Other Status Codes

DeploymentStacksError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Gebruikersaccount imiteren

Voorbeelden

DeploymentStacksList

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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"
      }
    }
  ]
}

Definities

Name Description
ActionOnUnmanage

Definieert het gedrag van resources die niet direct worden beheerd nadat de stack is bijgewerkt.

createdByType

Het type identiteit waarmee de resource is gemaakt.

DenySettings

Definieert hoe resources die door de implementatiestack zijn geïmplementeerd, zijn vergrendeld.

DenySettingsMode

denySettings-modus.

DenyStatusMode

denyAssignment-instellingen die zijn toegepast op de resource.

DeploymentStack

Implementatiestackobject.

DeploymentStackListResult

Lijst met implementatiestacks.

DeploymentStackProvisioningState

Status van de implementatiestack.

DeploymentStacksDebugSetting

De instelling voor foutopsporing.

DeploymentStacksDeleteDetachEnum

Hiermee geeft u de actie op die moet worden uitgevoerd op de resource wanneer de implementatiestack wordt verwijderd. Verwijderen probeert de resource te verwijderen uit Azure. Loskoppelen laat de resource in de huidige status staan.

DeploymentStacksError

Foutreactie implementatiestacks.

DeploymentStacksParametersLink

Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.

DeploymentStacksTemplateLink

Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

ManagedResourceReference

Het beheerde resourcemodel.

ResourceReference

Het resource-id-model.

ResourceReferenceExtended

Het uitgebreide resource-idmodel.

ResourceStatusMode

Huidige beheerstatus van de resource in de implementatiestack.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ActionOnUnmanage

Definieert het gedrag van resources die niet direct worden beheerd nadat de stack is bijgewerkt.

Name Type Description
managementGroups

DeploymentStacksDeleteDetachEnum

Hiermee geeft u de actie op die moet worden uitgevoerd op de resource wanneer de implementatiestack wordt verwijderd. Verwijderen probeert de resource te verwijderen uit Azure. Loskoppelen laat de resource in de huidige status staan.

resourceGroups

DeploymentStacksDeleteDetachEnum

Hiermee geeft u de actie op die moet worden uitgevoerd op de resource wanneer de implementatiestack wordt verwijderd. Verwijderen probeert de resource te verwijderen uit Azure. Loskoppelen laat de resource in de huidige status staan.

resources

DeploymentStacksDeleteDetachEnum

Hiermee geeft u de actie op die moet worden uitgevoerd op de resource wanneer de implementatiestack wordt verwijderd. Verwijderen probeert de resource te verwijderen uit Azure. Loskoppelen laat de resource in de huidige status staan.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
Application
Key
ManagedIdentity
User

DenySettings

Definieert hoe resources die door de implementatiestack zijn geïmplementeerd, zijn vergrendeld.

Name Type Description
applyToChildScopes

boolean

DenySettings wordt toegepast op onderliggende bereiken.

excludedActions

string[]

Lijst met beheerbewerkingen op basis van rollen die zijn uitgesloten van denySettings. Maximaal 200 acties zijn toegestaan. Als de denySetting-modus is ingesteld op denyWriteAndDelete, worden de volgende acties automatisch toegevoegd aan 'excludedActions': '*/read' en 'Microsoft.Authorization/locks/delete'. Als de denySetting-modus is ingesteld op DenyDelete, worden de volgende acties automatisch toegevoegd aan 'excludedActions': 'Microsoft.Authorization/locks/delete'. Dubbele acties worden verwijderd.

excludedPrincipals

string[]

Lijst met AAD-principal-id's die zijn uitgesloten van de vergrendeling. Maximaal 5 principals zijn toegestaan.

mode

DenySettingsMode

denySettings-modus.

DenySettingsMode

denySettings-modus.

Waarde Description
denyDelete

Geautoriseerde gebruikers kunnen de resources lezen en wijzigen, maar kunnen ze niet verwijderen.

denyWriteAndDelete

Geautoriseerde gebruikers kunnen alleen lezen uit een resource, maar kunnen deze niet wijzigen of verwijderen.

none

Er zijn geen denyAssignments toegepast.

DenyStatusMode

denyAssignment-instellingen die zijn toegepast op de resource.

Waarde Description
None

Er zijn geen denyAssignments toegepast.

denyDelete

Geautoriseerde gebruikers kunnen de resources lezen en wijzigen, maar kunnen ze niet verwijderen.

denyWriteAndDelete

Geautoriseerde gebruikers kunnen alleen lezen uit een resource, maar kunnen deze niet wijzigen of verwijderen.

inapplicable

denyAssignments worden niet ondersteund voor resources buiten het bereik van de implementatiestack.

notSupported

Resourcetype biedt geen ondersteuning voor denyAssignments.

removedBySystem

Toewijzing weigeren is verwijderd door Azure vanwege een wijziging in resourcebeheer (verplaatsing van beheergroep, enzovoort)

DeploymentStack

Implementatiestackobject.

Name Type Description
id

string

Tekenreeks-id die wordt gebruikt om een resource in Azure te vinden.

location

string

De locatie van de implementatiestack. Deze kan niet worden gewijzigd na het maken. Dit moet een van de ondersteunde Azure-locaties zijn.

name

string

Naam van deze resource.

properties.actionOnUnmanage

ActionOnUnmanage

Definieert het gedrag van resources die niet direct worden beheerd nadat de stack is bijgewerkt.

properties.debugSetting

DeploymentStacksDebugSetting

De foutopsporingsinstelling van de implementatie.

properties.deletedResources

ResourceReference[]

Een matrix met resources die zijn verwijderd tijdens de meest recente update.

properties.denySettings

DenySettings

Definieert hoe resources die door de stack zijn geïmplementeerd, zijn vergrendeld.

properties.deploymentId

string

De resourceId van de implementatieresource die is gemaakt door de implementatiestack.

properties.deploymentScope

string

Het bereik waarop de eerste implementatie moet worden gemaakt. Als er geen bereik is opgegeven, wordt standaard het bereik van de implementatiestack gebruikt. Geldige bereiken zijn: beheergroep (indeling: /providers/Microsoft.Management/managementGroups/{managementGroupId}), abonnement (indeling: '/subscriptions/{subscriptionId}'), resourcegroep (indeling: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').

properties.description

string

maxLength: 4096

Beschrijving van implementatiestack.

properties.detachedResources

ResourceReference[]

Een matrix met resources die zijn losgekoppeld tijdens de meest recente update.

properties.duration

string

De duur van de update van de implementatiestack.

properties.error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

properties.failedResources

ResourceReferenceExtended[]

Een matrix met resources die de doelstatus niet bereikt tijdens de meest recente update.

properties.outputs

object

De uitvoer van de onderliggende implementatie.

properties.parameters

object

Naam- en waardeparen waarmee de implementatieparameters voor de sjabloon worden gedefinieerd. Gebruik dit element wanneer u de parameterwaarden rechtstreeks in de aanvraag opgeeft in plaats van een koppeling naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn.

properties.parametersLink

DeploymentStacksParametersLink

De URI van het parameterbestand. Gebruik dit element om een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide.

properties.provisioningState

DeploymentStackProvisioningState

Status van de implementatiestack.

properties.resources

ManagedResourceReference[]

Een matrix met resources die momenteel worden beheerd door de implementatiestack.

properties.template

object

De sjablooninhoud. U gebruikt dit element als u de syntaxis van de sjabloon rechtstreeks in de aanvraag wilt doorgeven in plaats van een koppeling naar een bestaande sjabloon. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.

properties.templateLink

DeploymentStacksTemplateLink

De URI van de sjabloon. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

tags

object

Resourcetags voor de implementatiestack.

type

string

Type van deze resource.

DeploymentStackListResult

Lijst met implementatiestacks.

Name Type Description
nextLink

string

De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten.

value

DeploymentStack[]

Een matrix van implementatiestacks.

DeploymentStackProvisioningState

Status van de implementatiestack.

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

DeploymentStacksDebugSetting

De instelling voor foutopsporing.

Name Type Description
detailLevel

string

Hiermee geeft u het type informatie op dat moet worden vastgelegd voor foutopsporing. De toegestane waarden zijn geen, requestContent, responseContent of zowel requestContent als responseContent, gescheiden door een komma. De standaardwaarde is geen. Houd bij het instellen van deze waarde zorgvuldig rekening met het type informatie dat wordt doorgegeven tijdens de implementatie. Door informatie over de aanvraag of het antwoord te registreren, kunnen gevoelige gegevens die worden opgehaald via de implementatiebewerkingen mogelijk worden weergegeven.

DeploymentStacksDeleteDetachEnum

Hiermee geeft u de actie op die moet worden uitgevoerd op de resource wanneer de implementatiestack wordt verwijderd. Verwijderen probeert de resource te verwijderen uit Azure. Loskoppelen laat de resource in de huidige status staan.

Waarde Description
delete
detach

DeploymentStacksError

Foutreactie implementatiestacks.

Name Type Description
error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.

Name Type Description
contentVersion

string

Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon.

uri

string

De URI van het parameterbestand.

Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.

Name Type Description
contentVersion

string

Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon.

id

string

De resource-id van een sjabloonspecificatie. Gebruik de id of URI-eigenschap, maar niet beide.

queryString

string

De querytekenreeks (bijvoorbeeld een SAS-token) die moet worden gebruikt met de templateLink-URI.

relativePath

string

De relatievePath-eigenschap kan worden gebruikt om een gekoppelde sjabloon te implementeren op een locatie ten opzichte van het bovenliggende item. Als de bovenliggende sjabloon is gekoppeld aan een TemplateSpec, verwijst dit naar een artefact in de TemplateSpec. Als het bovenliggende item is gekoppeld aan een URI, is de onderliggende implementatie een combinatie van de bovenliggende en relatievePath-URI's

uri

string

De URI van de sjabloon die moet worden geïmplementeerd. Gebruik de eigenschap URI of id, maar niet beide.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ManagedResourceReference

Het beheerde resourcemodel.

Name Type Default value Description
denyStatus

DenyStatusMode

None

denyAssignment-instellingen die zijn toegepast op de resource.

id

string

De resourceId van een resource die wordt beheerd door de implementatiestack.

status

ResourceStatusMode

None

Huidige beheerstatus van de resource in de implementatiestack.

ResourceReference

Het resource-id-model.

Name Type Description
id

string

De resourceId van een resource die wordt beheerd door de implementatiestack.

ResourceReferenceExtended

Het uitgebreide resource-idmodel.

Name Type Description
error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

id

string

De resourceId van een resource die wordt beheerd door de implementatiestack.

ResourceStatusMode

Huidige beheerstatus van de resource in de implementatiestack.

Waarde Description
Managed

Deze resource wordt beheerd door de implementatiestack.

None

Er zijn geen denyAssignments toegepast.

deleteFailed

Kan de resource niet verwijderen uit Azure. De verwijdering wordt opnieuw uitgevoerd bij de volgende stackimplementatie of kan handmatig worden verwijderd.

removeDenyFailed

Kan de weigeringstoewijzing voor de resource niet verwijderen.

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.