Deployment Stacks - List At Management Group

Usługa:: Resource Management

Wersja API:: 2022-08-01-preview

Wyświetla listę stosów wdrożenia w określonym zakresie.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
managementGroupId	path	True	string minLength: 1	Identyfikator grupy zarządzania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DeploymentStackListResult	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List management group Deployment stacks

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
ActionOnUnmanage	Definiuje zachowanie zasobów, które nie są już zarządzane po zaktualizowaniu lub usunięciu stosu.
createdByType	Typ tożsamości, która utworzyła zasób.
DenySettings	Określa sposób blokowania zasobów wdrożonych przez stos wdrożenia.
DenySettingsMode	denySettings Tryb, który definiuje odrzucone akcje.
DenyStatusMode	denyAssignment ustawienia zastosowane do zasobu.
DeploymentParameter	Parametr wdrożenia szablonu.
DeploymentStack	Obiekt stosu wdrożenia.
DeploymentStackListResult	Odpowiedź operacji listy DeploymentStack.
DeploymentStackProvisioningState	Stan stosu wdrożenia.
DeploymentStacksDebugSetting	Ustawienie debugowania.
DeploymentStacksParametersLink	Jednostka reprezentująca odwołanie do parametrów wdrożenia.
DeploymentStacksTemplateLink	Jednostka reprezentująca odwołanie do szablonu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
KeyVaultParameterReference	Dokumentacja parametrów usługi Azure Key Vault.
KeyVaultReference	Dokumentacja usługi Azure Key Vault.
ManagedResourceReference	Model zarządzanych zasobów.
ResourceReference	Model resourceId.
ResourceReferenceExtended	Model rozszerzony resourceId. Służy to do dokumentowania zasobów, które zakończyły się niepowodzeniem, za pomocą identyfikatora resourceId i odpowiadającego mu błędu.
ResourceStatusMode	Bieżący stan zarządzania zasobu w stosie wdrożenia.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UnmanageActionManagementGroupMode	Określa akcję dla nowo niezarządzanego zasobu.
UnmanageActionResourceGroupMode	Określa akcję dla nowo niezarządzanej grupy zasobów.
UnmanageActionResourceMode	Określa akcję dla nowo niezarządzanego zasobu.

ActionOnUnmanage

Sprzeciwiać się

Definiuje zachowanie zasobów, które nie są już zarządzane po zaktualizowaniu lub usunięciu stosu.

Nazwa	Typ	Opis
managementGroups	UnmanageActionManagementGroupMode	Określa działanie dla nowo niezarządzanej grupy zarządzania zasobami.
resourceGroups	UnmanageActionResourceGroupMode	Określa akcję dla nowo niezarządzanej grupy zasobów.
resources	UnmanageActionResourceMode	Określa akcję dla nowo niezarządzanego zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DenySettings

Sprzeciwiać się

Określa sposób blokowania zasobów wdrożonych przez stos wdrożenia.

Nazwa	Typ	Opis
applyToChildScopes	boolean	DenySettings zostanie zastosowany do zakresów zasobów podrzędnych każdego zarządzanego zasobu z przypisaniem odmowy.
excludedActions	string[]	Lista operacji zarządzania opartych na rolach, które są wykluczone z ustawienia denySettings. Dozwolone są maksymalnie 200 akcji. Jeśli tryb denySetting jest ustawiony na "denyWriteAndDelete", następujące akcje są automatycznie dołączane do "excludedActions": "*/read" i "Microsoft.Authorization/locks/delete". Jeśli tryb denySetting jest ustawiony na "denyDelete", następujące akcje są automatycznie dołączane do "excludedActions": "Microsoft.Authorization/locks/delete". Zduplikowane akcje zostaną usunięte.
excludedPrincipals	string[]	Lista identyfikatorów podmiotów zabezpieczeń usługi AAD wykluczonych z blokady. Dozwolone są maksymalnie 5 podmiotów zabezpieczeń.
mode	DenySettingsMode	denySettings Tryb, który definiuje odrzucone akcje.

DenySettingsMode

Wyliczenie

denySettings Tryb, który definiuje odrzucone akcje.

Wartość	Opis
denyDelete	Autoryzowani użytkownicy mogą odczytywać i modyfikować zasoby, ale nie mogą ich usuwać.
denyWriteAndDelete	Autoryzowani użytkownicy mogą odczytywać dane z zasobu, ale nie mogą go modyfikować ani usuwać.
none	Nie zastosowano żadnych przypisań denyAssignments.

DenyStatusMode

Wyliczenie

denyAssignment ustawienia zastosowane do zasobu.

Wartość	Opis
denyDelete	Autoryzowani użytkownicy mogą odczytywać i modyfikować zasoby, ale nie mogą ich usuwać.
notSupported	Typ zasobu nie obsługuje atrybutów denyAssignments.
inapplicable	denyAssignments nie są obsługiwane w zasobach spoza zakresu stosu wdrożenia.
denyWriteAndDelete	Autoryzowani użytkownicy mogą odczytywać tylko z zasobu, ale nie mogą go modyfikować ani usuwać.
removedBySystem	Przypisanie odmowy zostało usunięte przez platformę Azure z powodu zmiany zarządzania zasobami (przenoszenie grupy zarządzania itp.)
none	Nie zastosowano żadnych przypisań denyAssignments.

DeploymentParameter

Sprzeciwiać się

Parametr wdrożenia szablonu.

Nazwa	Typ	Opis
reference	KeyVaultParameterReference	Dokumentacja parametrów usługi Azure Key Vault.
type	string	Typ wartości.
value		Wprowadź wartość do parametru.

DeploymentStack

Sprzeciwiać się

Obiekt stosu wdrożenia.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokalizacja geograficzna, w której znajduje się zasób. Wymagane w przypadku stosów o zakresie subskrypcji i grupy zarządzania. Lokalizacja jest dziedziczona z grupy zasobów dla stosów o zakresie grupy zasobów.
name	string	Nazwa zasobu
properties.actionOnUnmanage	ActionOnUnmanage	Definiuje zachowanie zasobów, które nie są już zarządzane po zaktualizowaniu lub usunięciu stosu wdrożenia.
properties.debugSetting	DeploymentStacksDebugSetting	Ustawienie debugowania wdrożenia.
properties.deletedResources	ResourceReference[]	Tablica zasobów, które zostały usunięte podczas ostatniej aktualizacji stosu wdrożenia. Usunięte oznacza, że zasób został usunięty z szablonu i określono odpowiednie operacje usuwania.
properties.denySettings	DenySettings	Definiuje sposób, w jaki zasoby wdrażane przez stos są zablokowane.
properties.deploymentId	string	ResourceId zasobu wdrożenia utworzonego przez stos wdrożenia.
properties.deploymentScope	string	Zakres, w którym należy utworzyć początkowe wdrożenie. Jeśli zakres nie zostanie określony, domyślnie będzie to zakres stosu wdrożenia. Prawidłowe zakresy to: grupa zarządzania (format: "/providers/Microsoft.Management/managementGroups/{managementGroupId}"), subskrypcja (format: "/subscriptions/{subscriptionId}"), grupa zasobów (format: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}").
properties.description	string maxLength: 4096	Opis stosu wdrożenia. Maksymalna długość 4096 znaków.
properties.detachedResources	ResourceReference[]	Tablica zasobów, które zostały odłączone podczas najnowszej aktualizacji stosu wdrożenia. Odłączony oznacza, że zasób został usunięty z szablonu, ale nie określono żadnych odpowiednich operacji usuwania. W związku z tym zasób nadal istnieje, ale nie jest już skojarzony ze stosem.
properties.duration	string	Czas trwania ostatniej pomyślnej aktualizacji stosu wdrożenia.
properties.error	ErrorDetail	Szczegóły błędu.
properties.failedResources	ResourceReferenceExtended[]	Tablica zasobów, które nie osiągnęły stanu celu podczas ostatniej aktualizacji. Każdemu identyfikatorowi resourceId towarzyszy komunikat o błędzie.
properties.outputs		Dane wyjściowe zasobu wdrożenia utworzonego przez stos wdrożenia.
properties.parameters	<string, DeploymentParameter>	Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Użyj tego elementu, podając wartości parametrów bezpośrednio w żądaniu, zamiast łączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu.
properties.parametersLink	DeploymentStacksParametersLink	Identyfikator URI pliku parametrów. Użyj tego elementu, aby połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu.
properties.provisioningState	DeploymentStackProvisioningState	Stan stosu wdrożenia.
properties.resources	ManagedResourceReference[]	Tablica zasobów obecnie zarządzanych przez stos wdrożenia.
properties.template		Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.
properties.templateLink	DeploymentStacksTemplateLink	Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Sprzeciwiać się

Odpowiedź operacji listy DeploymentStack.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony z elementami
value	DeploymentStack[]	Elementy DeploymentStack na tej stronie

DeploymentStackProvisioningState

Wyliczenie

Stan stosu wdrożenia.

Wartość	Opis
creating	Stos wdrożenia jest obecnie tworzony
validating	Stos wdrożenia jest obecnie weryfikowany
waiting	Stos wdrożenia jest obecnie w oczekiwaniu
deploying	Stos wdrożenia jest obecnie wdrażany
canceling	Stos wdrożenia jest anulowany
updatingDenyAssignments	Stos wdrożenia aktualizuje przypisania odmowy
deletingResources	Stos wdrożenia usuwa zasoby
succeeded	Stos wdrożenia został ukończony pomyślnie
failed	Stos wdrożenia nie powiódł się
canceled	Stos wdrożenia został anulowany
deleting	Stos wdrożenia jest usuwany

DeploymentStacksDebugSetting

Sprzeciwiać się

Ustawienie debugowania.

Nazwa	Typ	Opis
detailLevel	string	Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, poufne dane pobierane za pośrednictwem operacji wdrażania mogą być potencjalnie uwidocznione.

DeploymentStacksParametersLink

Sprzeciwiać się

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Nazwa	Typ	Opis
contentVersion	string	W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.
uri	string	Identyfikator URI pliku parametrów.

DeploymentStacksTemplateLink

Sprzeciwiać się

Jednostka reprezentująca odwołanie do szablonu.

Nazwa	Typ	Opis
contentVersion	string	W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.
id	string	Identyfikator resourceId specyfikacji szablonu. Użyj właściwości id lub uri, ale nie obu.
queryString	string	Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink.
relativePath	string	Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i relativePath.
uri	string	Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu.

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

KeyVaultParameterReference

Sprzeciwiać się

Dokumentacja parametrów usługi Azure Key Vault.

Nazwa	Typ	Opis
keyVault	KeyVaultReference	Dokumentacja usługi Azure Key Vault.
secretName	string	Nazwa wpisu tajnego usługi Azure Key Vault.
secretVersion	string	Wersja wpisu tajnego usługi Azure Key Vault.

KeyVaultReference

Sprzeciwiać się

Dokumentacja usługi Azure Key Vault.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi Azure Key Vault.

ManagedResourceReference

Sprzeciwiać się

Model zarządzanych zasobów.

Nazwa	Typ	Wartość domyślna	Opis
denyStatus	DenyStatusMode	none	denyAssignment ustawienia zastosowane do zasobu.
id	string		Identyfikator zasobu usługi ARM zasobu zarządzanego przez stos wdrożenia.
status	ResourceStatusMode	none	Bieżący stan zarządzania zasobu w stosie wdrożenia.

ResourceReference

Sprzeciwiać się

Model resourceId.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM zasobu zarządzanego przez stos wdrożenia.

ResourceReferenceExtended

Sprzeciwiać się

Model rozszerzony resourceId. Służy to do dokumentowania zasobów, które zakończyły się niepowodzeniem, za pomocą identyfikatora resourceId i odpowiadającego mu błędu.

Nazwa	Typ	Opis
error	ErrorDetail	Szczegóły błędu.
id	string	Identyfikator zasobu usługi ARM zasobu zarządzanego przez stos wdrożenia.

ResourceStatusMode

Wyliczenie

Bieżący stan zarządzania zasobu w stosie wdrożenia.

Wartość	Opis
managed	Ten zasób jest zarządzany przez stos wdrożenia.
removeDenyFailed	Nie można usunąć przypisania odmowy dla zasobu.
deleteFailed	Nie można usunąć zasobu z platformy Azure. Usunięcie zostanie ponowione podczas następnego wdrożenia stosu lub można je usunąć ręcznie.
none	Brak stanu zarządzania.

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UnmanageActionManagementGroupMode

Wyliczenie

Określa akcję dla nowo niezarządzanego zasobu.

Wartość	Opis
delete	Usuń grupy zarządzania z Azure.
detach	Zachowaj grupy zarządzania w Azure.

UnmanageActionResourceGroupMode

Wyliczenie

Określa akcję dla nowo niezarządzanej grupy zasobów.

Wartość	Opis
delete	Usuń grupy zasobów z Azure.
detach	Zachowaj grupy zasobów w Azure.

UnmanageActionResourceMode

Wyliczenie

Określa akcję dla nowo niezarządzanego zasobu.

Wartość	Opis
delete	Usuń zasoby z Azure
detach	Zachowaj zasoby w Azure

Udostępnij za pośrednictwem

Deployment Stacks - List At Management Group

Parametry URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

List management group Deployment stacks

Przykładowa prośba

Przykładowa odpowiedź

Definicje

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