Deployments - Get

Service:

Resource Management

API-versie:

2021-04-01

Hiermee haalt u een implementatie op.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI-parameters

Name	In	Vereist	Type	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._\(\)]+$	De naam van de implementatie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De microsoft Azure-abonnements-id.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	DeploymentExtended	OK: retourneert informatie over de implementatie, inclusief de inrichtingsstatus.
Other Status Codes	CloudError	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	Uw gebruikersaccount imiteren

Definities

Name	Description
Alias	Het aliastype.
AliasPath	Het type paden voor alias.
AliasPathAttributes	De kenmerken van het token waarnaar het aliaspad verwijst.
AliasPathMetadata
AliasPathTokenType	Het type token waarnaar het aliaspad verwijst.
AliasPattern	Het type van het patroon voor een aliaspad.
AliasPatternType	Het type aliaspatroon
AliasType	Het type alias.
ApiProfile
BasicDependency	Informatie over implementatieafhankelijkheid.
CloudError	Een foutbericht voor een aanvraag voor resourcebeheer.
DebugSetting	De instelling voor foutopsporing.
Dependency	Informatie over implementatieafhankelijkheid.
DeploymentExtended	Implementatiegegevens.
DeploymentMode	De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen.
DeploymentPropertiesExtended	Implementatie-eigenschappen met aanvullende informatie.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
OnErrorDeploymentExtended	Implementatie van foutgedrag met aanvullende informatie.
OnErrorDeploymentType	De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.
ParametersLink	Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.
Provider	Resourceprovidergegevens.
ProviderAuthorizationConsentState	De autorisatiestatus van de provider.
ProviderExtendedLocation	De uitgebreide locatie van de provider.
ProviderResourceType	Resourcetype dat wordt beheerd door de resourceprovider.
ProvisioningState	Geeft de status van inrichting aan.
ResourceReference	Het resource-id-model.
TemplateLink	Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.
ZoneMapping

Alias

Object

Het aliastype.

Name	Type	Description
defaultMetadata	AliasPathMetadata	De standaardaliaspadmetagegevens. Van toepassing op het standaardpad en op een aliaspad dat geen metagegevens bevat
defaultPath	string	Het standaardpad voor een alias.
defaultPattern	AliasPattern	Het standaardpatroon voor een alias.
name	string	De aliasnaam.
paths	AliasPath[]	De paden voor een alias.
type	AliasType	Het type alias.

AliasPath

Object

Het type paden voor alias.

Name	Type	Description
apiVersions	string[]	De API-versies.
metadata	AliasPathMetadata	De metagegevens van het aliaspad. Als dit ontbreekt, moet u terugvallen op de standaardmetagegevens van de alias.
path	string	Het pad van een alias.
pattern	AliasPattern	Het patroon voor een aliaspad.

AliasPathAttributes

Inventarisatie

De kenmerken van het token waarnaar het aliaspad verwijst.

Waarde	Description
Modifiable	Het token waarnaar het aliaspad verwijst, kan worden gewijzigd door beleid met het effect Wijzigen.
None	Het token waarnaar het aliaspad verwijst, heeft geen kenmerken.

AliasPathMetadata

Object

Name	Type	Description
attributes	AliasPathAttributes	De kenmerken van het token waarnaar het aliaspad verwijst.
type	AliasPathTokenType	Het type token waarnaar het aliaspad verwijst.

AliasPathTokenType

Inventarisatie

Het type token waarnaar het aliaspad verwijst.

Waarde	Description
Any	Het tokentype kan van alles zijn.
Array	Het tokentype is matrix.
Boolean	Het tokentype is booleaanse waarde.
Integer	Het tokentype is een geheel getal.
NotSpecified	Het tokentype is niet opgegeven.
Number	Het tokentype is getal.
Object	Het tokentype is object.
String	Het tokentype is een tekenreeks.

AliasPattern

Object

Het type van het patroon voor een aliaspad.

Name	Type	Description
phrase	string	De aliaspatroonzin.
type	AliasPatternType	Het type aliaspatroon
variable	string	De aliaspatroonvariabele.

AliasPatternType

Inventarisatie

Het type aliaspatroon

Waarde	Description
Extract	Extraheren is de enige toegestane waarde.
NotSpecified	NotSpecified is niet toegestaan.

AliasType

Inventarisatie

Het type alias.

Waarde	Description
Mask	Aliaswaarde is geheim.
NotSpecified	Aliastype is onbekend (hetzelfde als het instellen van aliastype).
PlainText	Aliaswaarde is niet geheim.

ApiProfile

Object

Name	Type	Description
apiVersion	string	De API-versie.
profileVersion	string	De profielversie.

BasicDependency

Object

Informatie over implementatieafhankelijkheid.

Name	Type	Description
id	string	De id van de afhankelijkheid.
resourceName	string	De naam van de afhankelijkheidsresource.
resourceType	string	Het resourcetype voor afhankelijkheden.

CloudError

Object

Een foutbericht voor een aanvraag voor resourcebeheer.

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-foutreactie-indeling.)

DebugSetting

Object

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 u tijdens de implementatie doorgeeft. Door informatie over de aanvraag of het antwoord te registreren, kunt u mogelijk gevoelige gegevens beschikbaar maken die worden opgehaald via de implementatiebewerkingen.

Dependency

Object

Informatie over implementatieafhankelijkheid.

Name	Type	Description
dependsOn	BasicDependency[]	De lijst met afhankelijkheden.
id	string	De id van de afhankelijkheid.
resourceName	string	De naam van de afhankelijkheidsresource.
resourceType	string	Het resourcetype voor afhankelijkheden.

DeploymentExtended

Object

Implementatiegegevens.

Name	Type	Description
id	string	De id van de implementatie.
location	string	de locatie van de implementatie.
name	string	De naam van de implementatie.
properties	DeploymentPropertiesExtended	Implementatie-eigenschappen.
tags	object	Implementatietags
type	string	Het type implementatie.

DeploymentMode

Inventarisatie

De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen.

Waarde	Description
Complete
Incremental

DeploymentPropertiesExtended

Object

Implementatie-eigenschappen met aanvullende informatie.

Name	Type	Description
correlationId	string	De correlatie-id van de implementatie.
debugSetting	DebugSetting	De foutopsporingsinstelling van de implementatie.
dependencies	Dependency[]	De lijst met implementatieafhankelijkheden.
duration	string	De duur van de sjabloonimplementatie.
error	ErrorResponse	Foutreactie De implementatiefout.
mode	DeploymentMode	De implementatiemodus. Mogelijke waarden zijn Incrementeel en Voltooid.
onErrorDeployment	OnErrorDeploymentExtended	De implementatie op foutgedrag.
outputResources	ResourceReference[]	Matrix van ingerichte resources.
outputs	object	Sleutel-/waardeparen die de uitvoer van de implementatie vertegenwoordigen.
parameters	object	Implementatieparameters.
parametersLink	ParametersLink	De URI die verwijst naar de parameters.
providers	Provider[]	De lijst met resourceproviders die nodig zijn voor de implementatie.
provisioningState	ProvisioningState	Geeft de status van inrichting aan.
templateHash	string	De hash die voor de sjabloon is geproduceerd.
templateLink	TemplateLink	De URI die verwijst naar de sjabloon.
timestamp	string (date-time)	De tijdstempel van de sjabloonimplementatie.
validatedResources	ResourceReference[]	Matrix van gevalideerde resources.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorResponse

Object

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

OnErrorDeploymentExtended

Object

Implementatie van foutgedrag met aanvullende informatie.

Name	Type	Description
deploymentName	string	De implementatie die moet worden gebruikt voor een foutcase.
provisioningState	string	De status van de inrichting voor de on-foutimplementatie.
type	OnErrorDeploymentType	De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

OnErrorDeploymentType

Inventarisatie

De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

Waarde	Description
LastSuccessful
SpecificDeployment

ParametersLink

Object

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.

Provider

Object

Resourceprovidergegevens.

Name	Type	Description
id	string	De provider-id.
namespace	string	De naamruimte van de resourceprovider.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	De autorisatiestatus van de provider.
registrationPolicy	string	Het registratiebeleid van de resourceprovider.
registrationState	string	De registratiestatus van de resourceprovider.
resourceTypes	ProviderResourceType[]	De verzameling providerresourcetypen.

ProviderAuthorizationConsentState

Inventarisatie

De autorisatiestatus van de provider.

Waarde	Description
Consented
NotRequired
NotSpecified
Required

ProviderExtendedLocation

Object

De uitgebreide locatie van de provider.

Name	Type	Description
extendedLocations	string[]	De uitgebreide locaties voor de Azure-locatie.
location	string	De azure-locatie.
type	string	Het uitgebreide locatietype.

ProviderResourceType

Object

Resourcetype dat wordt beheerd door de resourceprovider.

Name	Type	Description
aliases	Alias[]	De aliassen die worden ondersteund door dit resourcetype.
apiProfiles	ApiProfile[]	De API-profielen voor de resourceprovider.
apiVersions	string[]	De API-versie.
capabilities	string	De extra mogelijkheden die door dit resourcetype worden aangeboden.
defaultApiVersion	string	De standaard-API-versie.
locationMappings	ProviderExtendedLocation[]	De locatietoewijzingen die worden ondersteund door dit resourcetype.
locations	string[]	De verzameling locaties waar dit resourcetype kan worden gemaakt.
properties	object	De eigenschappen.
resourceType	string	Het resourcetype.
zoneMappings	ZoneMapping[]

ProvisioningState

Inventarisatie

Geeft de status van inrichting aan.

Waarde	Description
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
NotSpecified
Ready
Running
Succeeded
Updating

ResourceReference

Object

Het resource-id-model.

Name	Type	Description
id	string	De volledig gekwalificeerde resource-id.

TemplateLink

Object

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.

ZoneMapping

Object

Name	Type	Description
location	string	De locatie van de zonetoewijzing.
zones	string[]