Deployments - Get At Management Group Scope

Usługa:

Resource Management

Wersja interfejsu API:

2021-04-01

Pobiera wdrożenie.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deploymentName	path	True	string	Nazwa wdrożenia. Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$
groupId	path	True	string	Identyfikator grupy zarządzania.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DeploymentExtended	OK — zwraca informacje o wdrożeniu, w tym o stanie aprowizacji.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Definicje

Nazwa	Opis
Alias	Typ aliasu.
AliasPath	Typ ścieżek dla aliasu.
AliasPathAttributes	Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
AliasPathMetadata
AliasPathTokenType	Typ tokenu, do którego odwołuje się ścieżka aliasu.
AliasPattern	Typ wzorca dla ścieżki aliasu.
AliasPatternType	Typ wzorca aliasu
AliasType	Typ aliasu.
ApiProfile
BasicDependency	Informacje o zależnościach wdrożenia.
CloudError	Odpowiedź na błąd żądania zarządzania zasobami.
DebugSetting	Ustawienie debugowania.
Dependency	Informacje o zależnościach wdrożenia.
DeploymentExtended	Informacje o wdrożeniu.
DeploymentMode	Tryb używany do wdrażania zasobów. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu pełnego, ponieważ możesz przypadkowo usunąć zasoby.
DeploymentPropertiesExtended	Właściwości wdrożenia z dodatkowymi szczegółami.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
OnErrorDeploymentExtended	Wdrażanie przy zachowaniu błędu z dodatkowymi szczegółami.
OnErrorDeploymentType	Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.
ParametersLink	Jednostka reprezentująca odwołanie do parametrów wdrożenia.
Provider	Informacje o dostawcy zasobów.
ProviderAuthorizationConsentState	Stan zgody autoryzacji dostawcy.
ProviderExtendedLocation	Lokalizacja rozszerzona dostawcy.
ProviderResourceType	Typ zasobu zarządzany przez dostawcę zasobów.
ProvisioningState	Określa stan aprowizacji.
ResourceReference	Model identyfikatora zasobu.
TemplateLink	Jednostka reprezentująca odwołanie do szablonu.
ZoneMapping

Alias

Typ aliasu.

Nazwa	Typ	Opis
defaultMetadata	AliasPathMetadata	Domyślne metadane ścieżki aliasu. Dotyczy ścieżki domyślnej i ścieżki aliasu, która nie ma metadanych
defaultPath	string	Domyślna ścieżka aliasu.
defaultPattern	AliasPattern	Domyślny wzorzec aliasu.
name	string	Nazwa aliasu.
paths	AliasPath[]	Ścieżki aliasu.
type	AliasType	Typ aliasu.

AliasPath

Typ ścieżek dla aliasu.

Nazwa	Typ	Opis
apiVersions	string[]	Wersje interfejsu API.
metadata	AliasPathMetadata	Metadane ścieżki aliasu. Jeśli brakuje, wróć do domyślnych metadanych aliasu.
path	string	Ścieżka aliasu.
pattern	AliasPattern	Wzorzec ścieżki aliasu.

AliasPathAttributes

Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.

Nazwa	Typ	Opis
Modifiable	string	Token, do którego odwołuje się ścieżka aliasu, można modyfikować przez zasady z efektem "modyfikuj".
None	string	Token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów.

AliasPathMetadata

Nazwa	Typ	Opis
attributes	AliasPathAttributes	Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
type	AliasPathTokenType	Typ tokenu, do którego odwołuje się ścieżka aliasu.

AliasPathTokenType

Typ tokenu, do którego odwołuje się ścieżka aliasu.

Nazwa	Typ	Opis
Any	string	Typ tokenu może być dowolny.
Array	string	Typ tokenu to tablica.
Boolean	string	Typ tokenu to wartość logiczna.
Integer	string	Typ tokenu to liczba całkowita.
NotSpecified	string	Nie określono typu tokenu.
Number	string	Typ tokenu to liczba.
Object	string	Typ tokenu to obiekt.
String	string	Typ tokenu to ciąg.

AliasPattern

Typ wzorca dla ścieżki aliasu.

Nazwa	Typ	Opis
phrase	string	Fraza wzorca aliasu.
type	AliasPatternType	Typ wzorca aliasu
variable	string	Zmienna wzorca aliasu.

AliasPatternType

Typ wzorca aliasu

Nazwa	Typ	Opis
Extract	string	Wyodrębnianie jest jedyną dozwoloną wartością.
NotSpecified	string	Pozycja NotSpecified jest niedozwolona.

AliasType

Typ aliasu.

Nazwa	Typ	Opis
Mask	string	Wartość aliasu jest wpisem tajnym.
NotSpecified	string	Typ aliasu jest nieznany (taki sam jak typ aliasu).
PlainText	string	Wartość aliasu nie jest wpisem tajnym.

ApiProfile

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API.
profileVersion	string	Wersja profilu.

BasicDependency

Informacje o zależnościach wdrożenia.

Nazwa	Typ	Opis
id	string	Identyfikator zależności.
resourceName	string	Nazwa zasobu zależności.
resourceType	string	Typ zasobu zależności.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

DebugSetting

Ustawienie debugowania.

Nazwa	Typ	Opis
detailLevel	string	Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to brak, requestContent, responseContent lub zarówno requestContent, jak i responseContent oddzielone przecinkiem. 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, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania.

Dependency

Informacje o zależnościach wdrożenia.

Nazwa	Typ	Opis
dependsOn	BasicDependency[]	Lista zależności.
id	string	Identyfikator zależności.
resourceName	string	Nazwa zasobu zależności.
resourceType	string	Typ zasobu zależności.

DeploymentExtended

Informacje o wdrożeniu.

Nazwa	Typ	Opis
id	string	Identyfikator wdrożenia.
location	string	lokalizacja wdrożenia.
name	string	Nazwa wdrożenia.
properties	DeploymentPropertiesExtended	Właściwości wdrożenia.
tags	object	Tagi wdrożenia
type	string	Typ wdrożenia.

DeploymentMode

Tryb używany do wdrażania zasobów. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu pełnego, ponieważ możesz przypadkowo usunąć zasoby.

Nazwa	Typ	Opis
Complete	string
Incremental	string

DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

Nazwa	Typ	Opis
correlationId	string	Identyfikator korelacji wdrożenia.
debugSetting	DebugSetting	Ustawienie debugowania wdrożenia.
dependencies	Dependency[]	Lista zależności wdrożenia.
duration	string	Czas trwania wdrożenia szablonu.
error	ErrorResponse	Odpowiedź na błąd Błąd wdrożenia.
mode	DeploymentMode	Tryb wdrażania. Możliwe wartości to Przyrostowe i Ukończone.
onErrorDeployment	OnErrorDeploymentExtended	Wdrożenie przy zachowaniu błędu.
outputResources	ResourceReference[]	Tablica zaaprowizowanych zasobów.
outputs	object	Pary klucz/wartość reprezentujące dane wyjściowe wdrożenia.
parameters	object	Parametry wdrożenia.
parametersLink	ParametersLink	Identyfikator URI odwołujące się do parametrów.
providers	Provider[]	Lista dostawców zasobów potrzebnych do wdrożenia.
provisioningState	ProvisioningState	Określa stan aprowizacji.
templateHash	string	Skrót utworzony dla szablonu.
templateLink	TemplateLink	Identyfikator URI odwołujące się do szablonu.
timestamp	string	Sygnatura czasowa wdrożenia szablonu.
validatedResources	ResourceReference[]	Tablica zweryfikowanych zasobów.

ErrorAdditionalInfo

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

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

ErrorResponse

Odpowiedź na błąd

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

OnErrorDeploymentExtended

Wdrażanie przy zachowaniu błędu z dodatkowymi szczegółami.

Nazwa	Typ	Opis
deploymentName	string	Wdrożenie, które ma być używane w przypadku błędu.
provisioningState	string	Stan aprowizacji dla wdrożenia przy błędzie.
type	OnErrorDeploymentType	Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

Nazwa	Typ	Opis
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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.

Provider

Informacje o dostawcy zasobów.

Nazwa	Typ	Opis
id	string	Identyfikator dostawcy.
namespace	string	Przestrzeń nazw dostawcy zasobów.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Stan zgody autoryzacji dostawcy.
registrationPolicy	string	Zasady rejestracji dostawcy zasobów.
registrationState	string	Stan rejestracji dostawcy zasobów.
resourceTypes	ProviderResourceType[]	Kolekcja typów zasobów dostawcy.

ProviderAuthorizationConsentState

Stan zgody autoryzacji dostawcy.

Nazwa	Typ	Opis
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

Lokalizacja rozszerzona dostawcy.

Nazwa	Typ	Opis
extendedLocations	string[]	Rozszerzone lokalizacje dla lokalizacji platformy Azure.
location	string	Lokalizacja platformy Azure.
type	string	Typ lokalizacji rozszerzonej.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

Nazwa	Typ	Opis
aliases	Alias[]	Aliasy obsługiwane przez ten typ zasobu.
apiProfiles	ApiProfile[]	Profile interfejsu API dla dostawcy zasobów.
apiVersions	string[]	Wersja interfejsu API.
capabilities	string	Dodatkowe możliwości oferowane przez ten typ zasobu.
defaultApiVersion	string	Domyślna wersja interfejsu API.
locationMappings	ProviderExtendedLocation[]	Mapowania lokalizacji obsługiwane przez ten typ zasobu.
locations	string[]	Kolekcja lokalizacji, w których można utworzyć ten typ zasobu.
properties	object	Właściwości.
resourceType	string	Typ zasobu.
zoneMappings	ZoneMapping[]

ProvisioningState

Określa stan aprowizacji.

Nazwa	Typ	Opis
Accepted	string
Canceled	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Ready	string
Running	string
Succeeded	string
Updating	string

ResourceReference

Model identyfikatora zasobu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu.

TemplateLink

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 zasobu 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, spowoduje to odwołanie 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.

ZoneMapping

Nazwa	Typ	Opis
location	string	Lokalizacja mapowania strefy.
zones	string[]