Deployment Stacks - List At Management Group

Služba:: Resource Management

Verze rozhraní API:: 2022-08-01-preview

Zobrazí seznam zásobníků nasazení v určeném oboru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
managementGroupId	path	True	string minLength: 1	ID skupiny pro správu.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DeploymentStackListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List management group Deployment stacks

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
ActionOnUnmanage	Definuje chování prostředků, které již nejsou spravovány po aktualizaci nebo odstranění balíčku.
createdByType	Typ identity, která prostředek vytvořila.
DenySettings	Definuje, jak jsou prostředky nasazené zásobníkem nasazení uzamčeny.
DenySettingsMode	denySettings Režim, který definuje odepřené akce.
DenyStatusMode	Odepřít nastavení přiřazení Assignment použité pro prostředek
DeploymentParameter	Parametr nasazení pro šablonu.
DeploymentStack	Objekt zásobníku nasazení
DeploymentStackListResult	Odpověď operace seznamu DeploymentStack.
DeploymentStackProvisioningState	Stav zásobníku nasazení
DeploymentStacksDebugSetting	Nastavení ladění.
DeploymentStacksParametersLink	Entita představující odkaz na parametry nasazení
DeploymentStacksTemplateLink	Entita představující odkaz na šablonu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
KeyVaultParameterReference	Referenční informace k parametrům Azure Key Vault.
KeyVaultReference	Referenční informace ke službě Azure Key Vault.
ManagedResourceReference	Model spravovaných prostředků.
ResourceReference	Model resourceId.
ResourceReferenceExtended	Rozšířený model resourceId. Používá se k dokumentaci neúspěšných prostředků s resourceId a odpovídající chybou.
ResourceStatusMode	Aktuální stav správy prostředku v zásobníku nasazení
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UnmanageActionManagementGroupMode	Určuje akci pro nově nespravovaný prostředek.
UnmanageActionResourceGroupMode	Specifikuje akci pro nově nespravovanou skupinu zdrojů.
UnmanageActionResourceMode	Určuje akci pro nově nespravovaný prostředek.

ActionOnUnmanage

Objekt

Definuje chování prostředků, které již nejsou spravovány po aktualizaci nebo odstranění balíčku.

Name	Typ	Description
managementGroups	UnmanageActionManagementGroupMode	Specifikuje akci pro nově nespravovanou skupinu pro správu zdrojů.
resourceGroups	UnmanageActionResourceGroupMode	Specifikuje akci pro nově nespravovanou skupinu zdrojů.
resources	UnmanageActionResourceMode	Určuje akci pro nově nespravovaný prostředek.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DenySettings

Objekt

Definuje, jak jsou prostředky nasazené zásobníkem nasazení uzamčeny.

Name	Typ	Description
applyToChildScopes	boolean	DenySettings se použije na rozsahy podřízených prostředků každého spravovaného prostředku s přiřazením zamítnutí.
excludedActions	string[]	Seznam operací správy založených na rolích, které jsou vyloučené z denySettings Je povoleno až 200 akcí. Pokud je režim denySetting nastavený na denyWriteAndDelete, připojí se k vyloučeným Akcím automaticky následující akce: */read a Microsoft.Authorization/locks/delete. Pokud je režim denySetting nastavený na denyDelete, připojí se k vyloučenéActions automaticky následující akce: Microsoft.Authorization/locks/delete. Duplicitní akce budou odebrány.
excludedPrincipals	string[]	Seznam ID objektu zabezpečení AAD vyloučených z zámku Je povoleno až 5 objektů zabezpečení.
mode	DenySettingsMode	denySettings Režim, který definuje odepřené akce.

DenySettingsMode

Výčet

denySettings Režim, který definuje odepřené akce.

Hodnota	Description
denyDelete	Oprávnění uživatelé mohou číst a upravovat prostředky, ale nemůžou je odstranit.
denyWriteAndDelete	Oprávnění uživatelé mohou číst ze zdroje, ale nemohou jej upravovat ani odstraňovat.
none	Nebyly použity žádné zákazyAssignments.

DenyStatusMode

Výčet

Odepřít nastavení přiřazení Assignment použité pro prostředek

Hodnota	Description
denyDelete	Oprávnění uživatelé mohou číst a upravovat prostředky, ale nemůžou je odstranit.
notSupported	Typ prostředku nepodporuje odepřít přiřazeníAssignments.
inapplicable	u prostředků mimo rozsah zásobníku nasazení se nepodporují přiřazení typu denyAssignments.
denyWriteAndDelete	Autorizovaní uživatelé můžou číst jenom z prostředku, ale nemůžou ho upravovat ani odstraňovat.
removedBySystem	Azure odebralo přiřazení zamítnutí kvůli změně správy prostředků (přesun skupiny pro správu atd.).
none	Nebyly použity žádné zákazyAssignments.

DeploymentParameter

Objekt

Parametr nasazení pro šablonu.

Name	Typ	Description
reference	KeyVaultParameterReference	Referenční informace k parametrům Azure Key Vault.
type	string	Typ hodnoty.
value		Vstupní hodnota parametru.

DeploymentStack

Objekt

Objekt zásobníku nasazení

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Geografická poloha, ve které se prostředek nachází. Vyžaduje se pro zásobníky s rozsahem předplatného a skupiny pro správu. Umístění je zděděno ze skupiny prostředků pro zásobníky s oborem skupiny prostředků.
name	string	Název prostředku
properties.actionOnUnmanage	ActionOnUnmanage	Definuje chování prostředků, které již nejsou spravovány po aktualizaci nebo odstranění zásobníku nasazení.
properties.debugSetting	DeploymentStacksDebugSetting	Nastavení ladění nasazení.
properties.deletedResources	ResourceReference[]	Pole prostředků, které byly odstraněny během poslední aktualizace zásobníku nasazení. Odstraněno znamená, že prostředek byl odebrán ze šablony a byly specifikovány příslušné operace odstranění.
properties.denySettings	DenySettings	Definuje, jak jsou prostředky nasazené zásobníkem uzamčené.
properties.deploymentId	string	ResourceId prostředku nasazení vytvořeného zásobníkem nasazení.
properties.deploymentScope	string	Obor, ve kterém se má vytvořit počáteční nasazení. Pokud není zadaný obor, nastaví se jako výchozí obor zásobníku nasazení. Platné obory jsou: skupina pro správu (formát: /providers/Microsoft.Management/managementGroups/{managementGroupId}), předplatné (formát: /subscriptions/{subscriptionId}), skupina prostředků (formát: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}).
properties.description	string maxLength: 4096	Popis zásobníku nasazení Maximální délka 4096 znaků.
properties.detachedResources	ResourceReference[]	Pole prostředků, které byly odpojeny během poslední aktualizace zásobníku nasazení. Odpojený znamená, že prostředek byl odebrán ze šablony, ale nebyly zadány žádné relevantní operace odstranění. Prostředek tedy stále existuje, i když již není přidružen k zásobníku.
properties.duration	string	Doba trvání poslední úspěšné aktualizace zásobníku nasazení.
properties.error	ErrorDetail	Podrobnosti o chybě.
properties.failedResources	ResourceReferenceExtended[]	Pole prostředků, které se nepodařilo dosáhnout stavu cíle během poslední aktualizace. Každé resourceId je doprovázeno chybovou zprávou.
properties.outputs		Výstupy prostředku nasazení vytvořeného zásobníkem nasazení.
properties.parameters	<string, DeploymentParameter>	Dvojice názvů a hodnot, které definují parametry nasazení pro šablonu. Tento prvek použijte při zadávání hodnot parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí.
properties.parametersLink	DeploymentStacksParametersLink	Identifikátor URI souboru parametrů. Tento prvek slouží k propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí.
properties.provisioningState	DeploymentStackProvisioningState	Stav zásobníku nasazení
properties.resources	ManagedResourceReference[]	Pole prostředků aktuálně spravovaných zásobníkem nasazení.
properties.template		Obsah šablony. Tento prvek použijete, pokud chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být řetězec JSON ve správném formátu nebo JObject. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.
properties.templateLink	DeploymentStacksTemplateLink	Identifikátor URI šablony. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Objekt

Odpověď operace seznamu DeploymentStack.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	DeploymentStack[]	Položky DeploymentStack na této stránce

DeploymentStackProvisioningState

Výčet

Stav zásobníku nasazení

Hodnota	Description
creating	Zásobník nasazení se právě vytváří
validating	Zásobník nasazení se právě ověřuje
waiting	Zásobník nasazení aktuálně čeká
deploying	Zásobník nasazení se právě nasazuje
canceling	Zásobník nasazení se ruší
updatingDenyAssignments	Zásobník nasazení aktualizuje přiřazení zamítnutí
deletingResources	Zásobník nasazení odstraňuje prostředky
succeeded	Zásobník nasazení byl úspěšně dokončen
failed	Zásobník nasazení se nezdařil
canceled	Zásobník nasazení byl zrušen
deleting	Odstraňuje se zásobník nasazení

DeploymentStacksDebugSetting

Objekt

Nastavení ladění.

Name	Typ	Description
detailLevel	string	Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty nejsou žádné, requestContent, responseContent nebo requestContent i responseContent oddělené čárkou. Výchozí hodnota není žádná. Při nastavování této hodnoty pečlivě zvažte typ informací, které se předávají během nasazení. Protokolováním informací o požadavku nebo odpovědi mohou být potenciálně vystavena citlivá data načtená prostřednictvím operací nasazení.

DeploymentStacksParametersLink

Objekt

Entita představující odkaz na parametry nasazení

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
uri	string	Identifikátor URI souboru parametrů.

DeploymentStacksTemplateLink

Objekt

Entita představující odkaz na šablonu.

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
id	string	ResourceId specifikace šablony. Použijte buď id uri vlastnost, ale ne obojí.
queryString	string	Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.
relativePath	string	Vlastnost relativePath lze použít k nasazení propojené šablony v umístění vzhledem k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v templateSpec. Pokud byl nadřazený objekt propojen s identifikátorem URI, bude podřízené nasazení kombinací nadřazeného identifikátoru URI a identifikátoru URI relativePath.
uri	string	Identifikátor URI šablony, který se má nasadit. Použijte vlastnost identifikátoru URI nebo ID, ale ne obě.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

KeyVaultParameterReference

Objekt

Referenční informace k parametrům Azure Key Vault.

Name	Typ	Description
keyVault	KeyVaultReference	Referenční informace ke službě Azure Key Vault.
secretName	string	Název tajného klíče Azure Key Vault.
secretVersion	string	Tajná verze Azure Key Vault.

KeyVaultReference

Objekt

Referenční informace ke službě Azure Key Vault.

Name	Typ	Description
id	string	ResourceId služby Azure Key Vault

ManagedResourceReference

Objekt

Model spravovaných prostředků.

Name	Typ	Default value	Description
denyStatus	DenyStatusMode	none	Odepřít nastavení přiřazení Assignment použité pro prostředek
id	string		ID prostředku ARM prostředku spravovaného zásobníkem nasazení.
status	ResourceStatusMode	none	Aktuální stav správy prostředku v zásobníku nasazení

ResourceReference

Objekt

Model resourceId.

Name	Typ	Description
id	string	ID prostředku ARM prostředku spravovaného zásobníkem nasazení.

ResourceReferenceExtended

Objekt

Rozšířený model resourceId. Používá se k dokumentaci neúspěšných prostředků s resourceId a odpovídající chybou.

Name	Typ	Description
error	ErrorDetail	Podrobnosti o chybě.
id	string	ID prostředku ARM prostředku spravovaného zásobníkem nasazení.

ResourceStatusMode

Výčet

Aktuální stav správy prostředku v zásobníku nasazení

Hodnota	Description
managed	Tento prostředek spravuje zásobník nasazení.
removeDenyFailed	Přiřazení zamítnutí zdroje nelze odebrat.
deleteFailed	Prostředek nelze odstranit z Azure. Odstranění se bude opakovat při dalším nasazení zásobníku nebo ho můžete odstranit ručně.
none	Žádný stav správy.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UnmanageActionManagementGroupMode

Výčet

Určuje akci pro nově nespravovaný prostředek.

Hodnota	Description
delete	Smažte management groups z Azure.
detach	Spravovací skupiny nechte v Azure.

UnmanageActionResourceGroupMode

Výčet

Specifikuje akci pro nově nespravovanou skupinu zdrojů.

Hodnota	Description
delete	Smažte skupiny zdrojů z Azure.
detach	Resource groups nechte v Azure.

UnmanageActionResourceMode

Výčet

Určuje akci pro nově nespravovaný prostředek.

Hodnota	Description
delete	Smažte zdroje z Azure
detach	Nechte zdroje v Azure

Sdílet prostřednictvím

Deployment Stacks - List At Management Group

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

List management group Deployment stacks

Ukázkový požadavek

Ukázková odpověď

Definice

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