Obter implantação
A operação Get Deployment
retorna informações de configuração, de status e de propriedades do sistema para uma implantação.
Solicitação
A solicitação Get Deployment
pode ser usada para recuperar os eventos de implantação para um slot de implantação único (preparo ou produção) ou para um nome de implantação específico. Se você desejar recuperar informações por nome de implantação, primeiro deverá obter o nome exclusivo da implantação. Esse nome exclusivo faz parte da resposta quando você faz uma solicitação para obter a implantação em um slot de implantação.
Por exemplo, se você tiver um serviço de nuvem implantado no ambiente de produção, poderá obter o nome exclusivo fazendo uma solicitação a …/deploymentslots/production
. A resposta inclui um elemento Name
para o serviço de nuvem. Esse valor do elemento Name
pode ser usado para fazer uma solicitação a …/deployments/<Name>
se você quiser recuperar informações sobre essa implantação específica.
Para gerar o URI da solicitação, substitua <subscription-id>
por sua ID de assinatura, <cloudservice-name>
pelo nome do serviço de nuvem, <deployment-slot>
por staging
ou production
ou <deployment-name>
pelo nome da sua implantação.
Método | URI da solicitação |
---|---|
GET | https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot> |
GET | https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name> |
Parâmetros de URI
Nenhum.
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos da solicitação.
Cabeçalho da solicitação | Descrição |
---|---|
x-ms-version |
Obrigatórios. Especifica a versão da operação a ser usada para esta solicitação. Esse cabeçalho deve ser definido como 2009-10-01 ou superior. |
Corpo da solicitação
Nenhum.
Resposta
A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Código de status
Uma operação bem-sucedida retorna o código de status 200 (OK).
Cabeçalhos de resposta
A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais.
Cabeçalho de Resposta | Descrição |
---|---|
x-ms-request-id |
Um valor que identifica exclusivamente uma solicitação feita no serviço de gerenciamento. |
Corpo da resposta
O exemplo de código a seguir mostra o formato do corpo da resposta:
<?xml version="1.0" encoding="utf-8"?>
<Deployment xmlns="http://schemas.microsoft.com/windowsazure">
<Name>name-of-deployment</Name>
<DeploymentSlot>current-deployment-environment</DeploymentSlot>
<PrivateID>identifier-of-deployment</PrivateID>
<Status>status-of-deployment</Status>
<Label>base64-encoded-name-of-deployment</Label>
<Url>url-of-deployment</Url>
<Configuration>base-64-encoded-configuration-file</Configuration>
<RoleInstanceList>
<RoleInstance>
<RoleName>name-of-role</RoleName>
<InstanceName>name-of-role-instance</InstanceName>
<InstanceStatus>status-of-role-instance</InstanceStatus>
<ExtendedInstanceStatus>additional-status-details</ExtendedInstanceStatus>
<InstanceUpgradeDomain>update-domain-of-role-instance</InstanceUpgradeDomain>
<InstanceFaultDomain>fault-domain-of-role-instance</InstanceFaultDomain>
<InstanceSize>size-of-role-instance</InstanceSize>
<InstanceStateDetails>state-of-role-instance</InstanceStateDetails>
<InstanceErrorCode>error-code-returned-for-role-instance</InstanceErrorCode>
<IpAddress>ip-address-of-role-instance</IpAddress>
<InstanceEndpoints>
<InstanceEndpoint>
<Name>name-of-endpoint</Name>
<Vip>virtual-ip-address-of-instance-endpoint</Vip>
<PublicPort>public-facing-port-of-instance-endpoint</PublicPort>
<LocalPort>internal-facing-port-of-instance-endpoint</LocalPort>
<Protocol>protocol-of-instance-endpoint</Protocol>
</InstanceEndpoint>
</InstanceEndpoints>
<PowerState>state-of-role-instance</PowerState>
<HostName>dns-name-of-service</HostName>
<RemoteAccessCertificateThumbprint>cert-thumbprint-for-remote-access</RemoteAccessCertificateThumbprint>
<GuestAgentStatus>
<ProtocolVersion>version-of-protocol</ProtocolVersion>
<Timestamp>status-report-time</Timestamp>
<GuestAgentVersion>version-of-agent</GuestAgentVersion>
<Status>status-of-agent</Status>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>agent-message</Message>
</FormattedMessage>
</GuestAgentStatus>
<ResourceExtensionStatusList>
<ResourceExtensionStatus>
<HandlerName>name-of-extension</HandlerName>
<Version>version-of-extension</Version>
<Status>status-of-extension</Status>
<Code>status-code-of-extension</Code>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>extension-message</Message>
</FormattedMessage>
<ExtensionSettingStatus>
<Timestamp>status-report-time</Timestamp>
<Name>name-of-setting</Name>
<Operation>operation-performed</Operation>
<Status>status-of-setting</Status>
<Code>status-code</Code>
<FormattedMessage>
<Language>language-of-status-message</Language>
<Message>status-message</Message>
</FormattedMessage>
<SubStatusList>
<SubStatus>
<Name>name-of-substatus-object</Name>
<Status>status-of-object</Status>
<FormattedMessage>
<Language>language-of-message</Language>
<Message>status-message</Message>
</FormattedMessage>
</SubStatus>
</SubStatusList>
</ExtensionSettingStatus>
</ResourceExtensionStatus>
</ResourceExtensionStatusList>
<PublicIPs>
<PublicIP>
<Name>name-of-public-ip</Name>
<Address>ip-address</Address>
<IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
<DomainNameLabel>domain-label</DomainNameLabel>
<Fqdns>
<Fqdn>fqdn</Fqdn>
</Fqdns>
<PublicIP>
<PublicIPs>
<NetworkInterfaces>
<NetworkInterface>
<Name>interface-name</Name>
<MacAddress>mac-address</MacAddress>
<IPConfigurations>
<IPConfiguration>
<SubnetName>subnet-name</SubnetName>
<Address>ip-address</Address>
</IPConfiguration>
<IPConfigurations>
</NetworkInterface>
</NetworkInterfaces>
</RoleInstance>
</RoleInstanceList>
<UpgradeStatus>
<UpgradeType>type-of-upgrade</UpgradeType>
<CurrentUpgradeDomainState>current-status-of-upgrade</CurrentUpgradeDomainState>
<CurrentUpgradeDomain>n</CurrentUpgradeDomain>
</UpgradeStatus>
<UpgradeDomainCount>number-of-upgrade-domains-in-deployment</UpgradeDomainCount>
<RoleList>
<Role>
<RoleName>name-of-role</RoleName>
<OsVersion>operating-system-version</OsVersion>
<ConfigurationSets>
<ConfigurationSet>
<ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>
<InputEndpoints>
<InputEndpoint>
<Port>port-number-of-input-endpoint-in-network</Port>
<Protocol>protocol-of-input-endpoint-in-network</Protocol>
<Vip>virtual-ip-address-of-input-endpoint-in-network</Vip>
</InputEndpoint>
</InputEndpoints>
<PublicIPs>
<PublicIP>
<Name>PublicIPName</Name>
<StaticVirtualNetworkIPAddress></StaticVirtualNetworkIPAddress>
<IdleTimeoutInMinutes></IdleTimeoutInMinutes>
<DomainNameLabel>domain-name</DomainNameLabel>
</PublicIP>
</PublicIPs>
<NetworkInterfaces>
<NetworkInterface>
<Name>interface-name</Name>
<IPConfigurations>
<IPConfiguration>
<SubnetName>subnet-name</SubnetName>
<StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
</IPConfiguration>
</IPConfigurations>
</NetworkInterface>
<NetworkInterfaces>
</ConfigurationSet>
</ConfigurationSets>
</Role>
<Role>
<RoleName>name-of-role</RoleName>
<OsVersion>operating-system-version</OsVersion>
<RoleType>PersistentVMRole</RoleType>
<LicenseType>type-of-license</LicenseType>
<ConfigurationSets>
<ConfigurationSet>
<ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>
<InputEndpoints>
<InputEndpoint>
<LoadBalancedEndpointSetName>name-of-load-balanced-endpoint-set</LoadBalancedEndpointSetName>
<LocalPort>internal-facing-port-of-input-endpoint</LocalPort>
<Name>name-of-input-endpoint</Name>
<Port>external-facing-port-of-input-endpoint</Port>
<LoadBalancerProbe>
<Path>path-of-probe</Path>
<Port>port-assigned-to-probe</Port>
<Protocol>protocol-of-probe-port</Protocol>
</LoadBalancerProbe>
<LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
<IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
<Protocol>protocol-of-input-endpoint</Protocol>
<Vip>virtual-ip-address-of-input-endpoint</Vip>
</InputEndpoint>
<InputEndpoints>
<SubnetNames>
<SubnetName>name-of-subnet</SubnetName>
</SubnetNames>
<StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
</ConfigurationSet>
</ConfigurationSets>
<ResourceExtensionReferences>
<ResourceExtensionReference>
<ReferenceName>name-of-reference</ReferenceName>
<Publisher>name-of-publisher</Publisher>
<Name>name-of-extension</Name>
<Version>version-of-extension</Version>
<ResourceExtensionParameterValues>
<ResourceExtensionParameterValue>
<Key>name-of-parameter-key</Key>
<Value>parameter-value</Value>
<Type>type-of-parameter</Type>
</ResourceExtensionParameterValue>
</ResourceExtensionParameterValues>
<State>state-of-resource</State>
</ResourceExtensionReference>
</ResourceExtensionReferences>
<AvailabilitySetName>name-of-availability-set</AvailabilitySetName>
<DataVirtualHardDisks>
<DataVirtualHardDisk>
<HostCaching>host-caching-mode-of-data-disk</HostCaching>
<DiskName>name-of-data-disk</DiskName>
<Lun>logical-unit-number-of-data-disk</Lun>
<LogicalDiskSizeInGB>size-of-data-disk</LogicalDiskSizeInGB>
<MediaLink>path-to-vhd</MediaLink>
<IOType>IO-Type<IOType>
</DataVirtualHardDisk>
</DataVirtualHardDisks>
<OSVirtualHardDisk>
<HostCaching>host-caching-mode-of-os-disk</HostCaching>
<DiskName>name-of-os-disk</DiskName>
<MediaLink>path-to-vhd</MediaLink>
<SourceImageName>image-used-to-create-os-disk</SourceImageName>
<OS>operating-system-on-os-disk</OS>
<RemoteSourceImageLink>path-to-source-image</RemoteSourceImageLink>
<IOType>IO-Type<IOType>
</OSVirtualHardDisk>
<RoleSize>size-of-instance</RoleSize>
<ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>
</Role>
</RoleList>
<SdkVersion>sdk-version-used-to-create-package</SdkVersion>
<Locked>status-of-deployment-write-allowed</Locked>
<RollbackAllowed>rollback-operation-allowed</RollbackAllowed>
<VirtualNetworkName>name-of-virtual-network</VirtualNetworkName>
<Dns>
<DnsServers>
<DnsServer>
<Name>name-of-dns-server</Name>
<Address>address-of-dns-server</Address>
</DnsServer>
</DnsServers>
</Dns>
<LoadBalancers>
<LoadBalancer>
<Name>name-of-internal-load-balancer</Name>
<FrontendIpConfiguration>
<Type>type-of-ip-address</Type>
<SubnetName>name-of-subnet</SubnetName>
<StaticVirtualNetworkIPAddress>static-ip-address</StaticVirtualNetworkIPAddress>
</FrontendIpConfiguration>
</LoadBalancer>
</LoadBalancers>
<ExtendedProperties>
<ExtendedProperty>
<Name>name-of-property</Name>
<Value>value-of-property</Value>
</ExtendedProperty>
</ExtendedProperties>
<PersistentVMDowntime>
<StartTime>start-of-downtime</StartTime>
<EndTime>end-of-downtime</EndTime>
<Status>status-of-downtime</Status>
</PersistentVMDowntime>
<VirtualIPs>
<VirtualIP>
<Address>virtual-ip-address-of-deployment</Address>
<IsReserved>indicator-of-ip-reservation</IsReserved>
<ReservedIPName>name-of-reserved-ip</ReservedIpName>
<Type>type-of-ip</Type>
</VirtualIP>
</VirtualIPs>
<ExtensionConfiguration>
<AllRoles>
<Extension>
<Id>identifier-of-extension</Id>
<SequenceNumber>configuration-sequence</SequenceNumber>
<State>state-of-extension</State>
</Extension>
</AllRoles>
<NamedRoles>
<Role>
<RoleName>role_name1</RoleName>
<Extensions>
<Extension>
<Id>identifier-of-extension</Id>
<SequenceNumber>configuration-sequence</SequenceNumber>
<State>state-of-extension</State>
</Extension>
</Extensions>
</Role>
</NamedRoles>
</ExtensionConfiguration>
<ReservedIPName>name-of-reserved-ip</ReservedIpName>
<InternalDnsSuffix>dns-suffix</InternalDnsSuffix>
</Deployment>
A tabela a seguir descreve os elementos no corpo da resposta.
Nome do elemento | Descrição |
---|---|
Nome | Especifica o nome da implantação. |
DeploymentSlot | Especifica o ambiente no qual o serviço de nuvem é implantado, staging ou production . |
PrivateID | Especifica um identificador exclusivo gerado internamente para essa implantação. |
Status | Especifica o status da implantação. Os valores possíveis são: - Running - Suspended - RunningTransitioning - SuspendedTransitioning - Starting - Suspending - Deploying - Deleting |
Rótulo | Especifica um identificador codificado em base 64 da implantação. Este identificador pode ser usado para suas finalidades de acompanhamento. |
Url | Especifica a URL que é usada para acessar o serviço de nuvem. Por exemplo, se o nome do serviço for MyService, você poderá acessar o serviço chamando: http:// MyService.cloudapp.net |
Configuração | Especifica o arquivo de configuração codificado em base 64 da implantação. |
RoleInstanceList | Contém a lista de instâncias de função da implantação. |
UpgradeStatus | Contém configurações que definem como a implantação é atualizada. |
UpgradeDomainCount | Contém um inteiro que representa o número total de domínios de atualização para a implantação. O UpgradeDomainCount elemento só está disponível usando a versão 2011-06-01 ou superior. |
RoleList | Contém a lista de funções da implantação. |
SdkVersion | Especifica a versão do SDK usada para gerar o pacote para a implantação. O SdkVersion elemento só está disponível usando a versão 2011-06-01 ou superior. |
Bloqueado | True para impedir uma nova operação de gravação na implantação enquanto ela estiver sendo atualizada; caso contrário, false .O Locked elemento só está disponível usando a versão 2011-06-01 ou superior. |
RollbackAllowed | True se a operação RollbackDeploymentUpdateOrUpgrade for permitida na implantação; caso contrário, false .O RollbackAllowed elemento só está disponível usando a versão 2011-06-01 ou superior. |
CreatedTime | Especifica a hora em que a implantação foi criada. |
LastModifiedTime | Especifica a última hora em que a implantação foi modificada. |
VirtualNetworkName | Especifica o nome da Rede Virtual à qual a Máquina Virtual se conecta. O VirtualNetworkName elemento só está disponível usando a versão 2012-03-01 ou superior. |
Dns | Contém as configurações de DNS especificadas para a implantação. O Dns elemento só está disponível usando a versão 2012-03-01 ou superior. |
LoadBalancers | Contém uma lista de balanceadores de carga internos que podem ser atribuídos a pontos de extremidade de entrada. O LoadBalancers elemento só está disponível usando a versão 2014-05-01 ou superior. |
ExtendedProperties | Especifica as propriedades usadas para fornecer mais informações sobre uma implantação. |
PersistentVMDowntime | Especifica informações sobre quando a máquina virtual foi iniciada e parada. O PersistentVMDowntime elemento só está disponível usando a versão 2012-03-01 ou superior. |
VirtualIPs | Especifica os endereços IP virtuais para a implantação. O VirtualIPs elemento só está disponível usando a versão 2012-03-01 ou superior. |
ExtensionConfiguration | Especifica uma extensão que é adicionada ao serviço de nuvem. No Azure, um processo pode ser executado como uma extensão de um serviço de nuvem. Você pode adicionar uma extensão a um serviço de nuvem usando Adicionar Extensão e adicionar a extensão à implantação usando a Implantação de Atualização ou Alterar a Configuração de Implantação. O ExtensionConfiguration elemento só está disponível usando a versão 2013-03-01 ou superior. |
ReservedIPName | Especifica o nome de um endereço IP reservado que deve ser atribuído à implantação. O ReservedIPName elemento só está disponível usando a versão 2014-05-01 ou superior. |
InternalDnsSuffix | Especifica o sufixo de nome de domínio para resolução de nomes internos automaticamente atribuído pelo Azure. Todas as instâncias de máquinas virtuais em uma implantação automaticamente recebem um sufixo de nome de domínio. Todas as instâncias de funções Web e funções de trabalho de uma implantação automaticamente recebem o sufixo de nome de domínio quando pelo menos uma função recebe um nome de computador com o atributo vmName . Uma implantação em uma VNET com um servidor DNS configurado não recebe um sufixo de nome de domínio interno.O InternalDnsSuffix elemento só está disponível usando a versão 2013-11-01 ou superior. |
RoleInstanceList
Contém a lista de instâncias de função da implantação.
Nome do elemento | Descrição |
---|---|
RoleName | Especifica o nome da função. |
InstanceName | Especifica o nome de uma instância de função em particular, caso uma instância da função esteja em execução. |
InstanceStatus | Especifica o status atual de uma instância de função.Unknown :- Indica que o estado da função é desconhecido no momento. CreatingVM :- Indica que os recursos estão sendo criados para uma Máquina Virtual. StartingVM :- Indica que uma Máquina Virtual está sendo iniciada. CreatingRole :- Indica que os recursos estão sendo criados para uma instância de função. StartingRole :- Indica que uma instância de função está sendo iniciada. ReadyRole :- Indica que uma instância de função foi iniciada e está pronta para ser usada. BusyRole :- Indica que uma instância de função não está disponível para solicitações. Geralmente, este estado é gerado quando a instância de função está sendo criada ou parada. StoppingRole :- Indica que uma instância de função está parando. StoppingVM :- Indica que uma Máquina Virtual está parando. DeletingVM :- Indica que uma Máquina Virtual está sendo excluída. StoppedVM :- Indica que uma Máquina Virtual não está em execução. Este é o estado final do processo de desligamento, e nenhuma outra mensagem de status deverá ser recebida depois de StoppedVM .RestartingRole :- Indica que uma instância de função foi interrompida inesperadamente ou falhou ao iniciar. Este status indica que há um problema com a instância de função que está causando a falha ou está impedindo seu início, e deve ser corrigido para que a instância de função possa ser iniciada. Os campos InstanceStateDetails e InstanceErrorCode podem conter informações sobre o erro de função que causou esse estado.CyclingRole :- Indica que uma função falhou continuamente após ser iniciada pelo Azure. Este status indica que há um problema com a função que a está impedindo de iniciar, e pode ser gerado após o recebimento dos status StartingRole e ReadyRole . O problema na função deve ser encontrado e corrigido antes que a função possa ser iniciada. Os campos InstanceStateDetails e InstanceErrorCode podem conter informações sobre o erro da função que causou este estado, que podem ser úteis na identificação e na depuração do problema. O elemento CyclingRole só será retornado se a versão for 2014-02-01 ou inferior.FailedStartingRole :- A função continuamente não foi iniciada. Este status indica que há um problema com a instância de função que a está impedindo de iniciar, e talvez seja gerado depois que o processo retorna StartingRole . O problema na função deve ser encontrado e corrigido antes que a função possa ser iniciada. Os campos InstanceStateDetails e InstanceErrorCode podem conter informações sobre o erro da função que causou este estado, que podem ser úteis na identificação e na depuração do problema.FailedStartingVM :- Indica que uma Máquina Virtual falhou continuamente ao iniciar. Este status é gerado pelo Azure e não indica um erro com a função. Pode ser gerado após o estado StartingRole .UnresponsiveRole :- Indica que uma instância de função atingiu o tempo limite antes de receber uma mensagem status e não está respondendo às solicitações. StoppedDeallocated :- Indica que uma instância de função foi interrompida e todos os recursos alocados foram liberados. Isso interrompe a cobrança da instância de função. Instâncias de função com um status StoppedDeallocated são retornadas apenas na lista de instâncias de função quando a versão é 2013-06-01 ou posterior. Se todas as instâncias de função na implantação tiverem um status StoppedDeallocated , a implantação não será retornada se a versão for inferior a 2013-06-01.Preparing :- Indica que o blob está sendo copiado do local de origem remoto. Este status só é devolvido se a versão for de 01.05.14 ou superior. |
ExtendedInstanceStatus | Especifica detalhes de status adicionais, se disponíveis para a implantação. Se um blob estiver sendo copiado a partir de uma localização da origem remota para uma conta de armazenamento, o valor deste elemento contém a porcentagem do blob que foi copiado. O ExtendedInstanceStatus elemento só está disponível usando a versão 2015-05-01 ou superior. |
InstanceUpgradeDomain | Especifica o domínio de atualização ao qual a instância de função pertence. Durante uma implantação de atualização, todas as funções no mesmo domínio de atualização são atualizadas ao mesmo tempo. O InstanceUpgradeDomain elemento só está disponível usando a versão 2011-06-01 ou superior. |
InstanceFaultDomain | Especifica o domínio de falha ao qual a instância de função pertence. As instâncias de função no mesmo domínio de falha podem estar vulneráveis à falha de um único hardware. O InstanceFaultDomain elemento só está disponível usando a versão 2011-06-01 ou superior. |
InstanceSize | Especifica o tamanho da instância de função. O InstanceSize elemento só está disponível usando a versão 2011-06-01 ou superior. |
InstanceStateDetails | Fornece um instantâneo do estado da instância de função no momento em que a operação foi chamada. O InstanceStateDetails elemento só está disponível usando a versão 2011-10-01 ou superior. |
InstanceErrorCode | O código de erro do início mais recente da função. Para Máquinas Virtuais, os códigos de erro são: - WaitTimeout - A instância de função não se comunicava dentro de 25 minutos. Normalmente, isso indica que ela não foi iniciada ou que o agente convidado não está instalado. - VhdTooLarge - A imagem VHD selecionada era muito grande para a instância de função. – AzureInternalError – ocorreu um erro interno que fez com que a instância de função falhasse ao iniciar. Contate o suporte para obter ajuda adicional. Para funções da Web e de trabalho, esse campo retorna um código de erro que pode ser fornecido ao suporte do Azure para auxiliar na resolução de erros. Tipicamente, este campo estará vazio. O InstanceErrorCode elemento só está disponível usando a versão 2011-10-01 ou superior. |
IpAddress | Especifica o endereço IP da instância de função (DIP). O IpAddress elemento só está disponível usando a versão 2012-03-01 ou superior. |
InstanceEndpoints | Contém a lista de pontos de extremidade de instância para a função. |
PowerState | O estado de execução da máquina virtual. O valores possíveis são os seguintes: - Starting - Started - Stopping - Stopped - Unknown |
HostName | Especifica o nome do host DNS do serviço de nuvem em que a instância de função está sendo executada. Este elemento é listado apenas para implantações de Máquina Virtual. |
RemoteAccessCertificateThumbprint | Especifica a impressão digital do certificado de servidor RDP (no Windows) ou do certificado de servidor SSH (no Linux). A impressão digital é usada apenas para Máquinas Virtuais que foram criadas a partir de uma imagem. O RemoteAccessCertificateThumbprint elemento só está disponível usando a versão 2012-08-01 ou superior. |
GuestAgentStatus | Especifica informações sobre o agente instalado em uma instância. O GuestAgentStatus elemento só está disponível usando a versão 2014-04-01 ou superior. |
ResourceExtensionStatusList | Especifica informações sobre as extensões instaladas em uma instância. O ResourceExtensionStatusList elemento só está disponível usando a versão 2014-04-01 ou superior. |
PublicIPs | Opcional. Contém um endereço IP público que pode ser usado em conjunto com o padrão de endereço IP virtual para a máquina virtual. O PublicIPs elemento só está disponível usando a versão 2014-05-01 ou superior. |
NetworkInterfaces | Opcional, um conjunto de interfaces de rede secundárias. O número de interfaces de rede secundárias permitido depende do tamanho da máquina virtual. O elemento NetworkInterfaces só está disponível com a versão 2014-08-01 ou superior. |
InstanceEndpoints
Contém a lista de pontos de extremidade de instância para a função.
Nome do elemento | Descrição |
---|---|
Nome | Especifica o nome do ponto de extremidade. |
Vip | Especifica o endereço IP virtual do ponto de extremidade. O Vip elemento só está disponível usando a versão 2011-06-01 ou superior. |
PublicPort | Especifica a porta externa que é usada pelo ponto de extremidade. |
LocalPort | Especifica a porta interna que é usada pelo ponto de extremidade. |
Protocolo | Especifica o protocolo do tráfego no ponto de extremidade. |
UpgradeStatus
Especifica informações sobre uma atualização que ocorre na implantação.
Nome do elemento | Descrição |
---|---|
UpgradeType | Especifica o tipo da atualização. Os valores possíveis são: - Auto - Manual - Simultaneous |
CurrentUpgradeDomainState | Especifica o estado atual da atualização. Os valores possíveis são Before e During . |
CurrentUpgradeDomain | Contém um valor inteiro que identifica o domínio de atualização atual. Os domínios de atualização são identificados por um índice de base zero: o primeiro domínio de atualização tem uma ID 0, o segundo tem uma ID 1 e assim por diante. |
RoleList
Contém a lista de funções da implantação.
Nome do elemento | Descrição |
---|---|
RoleName | Especifica o nome da função. |
OsVersion | Especifica a versão do sistema operacional do computador no qual as instâncias de função são executadas. |
RoleType | Especifica o tipo da função. Este elemento é listado apenas para implantações de Máquina Virtual e por padrão é PersistentVMRole . |
LicenseType | Especifica que a imagem ou o disco que está sendo usado foi licenciado localmente. Esse elemento só é usado para imagens que contêm o sistema operacional Windows Server. Os valores possíveis são: - Windows_Client - Windows_Server |
ConfigurationSets | Contém uma coleção de valores que representa parâmetros de configuração do sistema ou do aplicativo. |
AvailabilitySetName | Especifica o nome de uma coleção de máquinas virtuais. |
DataVirtualHardDisks | Contém os parâmetros que são usados para adicionar um disco de dados a uma Máquina Virtual. |
OSVirtualHardDisk | Contém os parâmetros que são usados para criar o disco do sistema operacional para uma Máquina Virtual. |
RoleSize | Especifica o tamanho da instância de função. |
ProvisionGuestAgent | Opcional. Indica se o VM Agent está instalado na máquina virtual. Para executar uma extensão de recurso em uma Máquina Virtual, esse serviço deverá ser instalado. Os valores possíveis são: - true - false |
ResourceExtensionReferences | Opcional. Contém uma coleção de extensões de recurso que serão instaladas na Máquina Virtual. Este elemento será usado se ProvisionGuestAgent for definido como true . |
ConfigurationSets
Contém uma coleção de objetos que fornecem dados do sistema ou do aplicativo.
Nome do elemento | Descrição |
---|---|
ConfigurationSetType | Especifica o tipo de configuração para o conjunto de configuração. No momento, isso é sempre definido como NetworkConfiguration. |
InputEndpoints | Contém uma coleção de pontos de extremidade externos para uma Máquina Virtual. |
SubnetNames | Contém uma lista de nomes de sub-rede de Rede Virtual à qual a implantação pertence. |
PublicIPs | Opcional. Contém um endereço IP público que pode ser usado em conjunto com o padrão de endereço IP virtual para a máquina virtual. O PublicIPs elemento só está disponível usando a versão 2014-05-01 ou superior. |
NetworkInterfaces | Opcional, um conjunto de interfaces de rede secundárias. O número de interfaces de rede secundárias permitido depende do tamanho da máquina virtual. O elemento NetworkInterfaces só está disponível com a versão 2014-08-01 ou superior. |
StaticVirtualNetworkIPAddress | Especifica o endereço IP interno da Máquina Virtual em uma Rede Virtual. Se esse elemento for especificado, o elemento SubnetNames conterá apenas uma sub-rede. O endereço IP especificado nesse elemento pertence à sub-rede definida em SubnetNames. O StaticVirtualNetworkIPAddress elemento só está disponível usando a versão 2013-11-01 ou superior. |
InputEndpoints
Contém uma coleção de pontos de extremidade externos para uma Máquina Virtual.
Nome do elemento | Descrição |
---|---|
LoadBalancedEndpointSetName | Especifica um nome de um conjunto de pontos de extremidade com balanceamento de carga. Este elemento é listado apenas para implantações de Máquina Virtual. |
LocalPort | Especifica a porta interna em que a Máquina Virtual está escutando para atender o ponto de extremidade. Este elemento é listado apenas para implantações de Máquina Virtual. |
Nome | Especifica o nome para o ponto de extremidade externo. Este elemento é listado apenas para implantações de Máquina Virtual. |
Porta | Especifica a porta externa a ser usada para o ponto de extremidade. |
LoadBalancerProbe | Contém as configurações de ponto de extremidade que o balanceador de carga do Azure usa para monitorar a disponibilidade de uma Máquina Virtual antes de encaminhar o tráfego para o ponto de extremidade. |
LoadBalancerName | Opcional. Especifica o nome do balanceador de carga interno que está associado a este ponto de extremidade. O nome do balanceador de carga interno é especificado em LoadBalancers. O LoadBalancerName elemento só está disponível usando a versão 2014-05-01 ou superior. |
IdleTimeoutInMinutes | Opcional. Especifica o tempo limite para a conexão TCP ociosa. O valor pode ser definido entre 4 e 30 minutos. O valor padrão é 4 minutos. Este elemento é utilizado apenas quando o protocolo é definido como TCP. O IdleTimeoutInMinutes elemento só está disponível usando a versão 2014-06-01 ou superior. |
Protocolo | Especifica o protocolo de transporte para o ponto de extremidade. Os possíveis valores são: - TCP - UDP |
Vip | Especifica o endereço IP virtual para o ponto de extremidade. |
LoadBalancerProbe
Contém as configurações de ponto de extremidade que o balanceador de carga do Azure usa para monitorar a disponibilidade de uma Máquina Virtual antes de encaminhar o tráfego para o ponto de extremidade.
Nome do elemento | Descrição |
---|---|
Caminho | Especifica o nome do caminho relativo a ser inspecionado para determinar o status de disponibilidade. Se Protocolo estiver definido como TCP, esse valor deverá ser NULL. Exemplo: caminho A investigação será usada https://example.com/path para executar a investigação. |
Porta | Especifica a porta a ser usada para inspecionar o status de disponibilidade. |
Protocolo | Especifica o protocolo a ser usado para inspecionar o status de disponibilidade. Os valores possíveis são: - HTTP - TCP |
DNS
Especifica as configurações personalizadas de DNS especificadas para a implantação.
Nome do elemento | Descrição |
---|---|
Nome | Especifica o nome do servidor DNS. |
Endereço | Especifica o endereço IP do servidor DNS. |
ExtendedProperties
Especifica as propriedades usadas para fornecer mais informações sobre uma implantação.
Nome do elemento | Descrição |
---|---|
Nome | Especifica o nome de uma propriedade que é associada à implantação. |
Valor | Especifica o valor de uma propriedade associada à implantação. |
PersistentVMDowntime
Especifica informações sobre quando a Máquina Virtual foi iniciada e parada.
Nome do elemento | Descrição |
---|---|
StartTime | Especifica a hora em que a Máquina Virtual foi iniciada. |
EndTime | Especifica a hora em que a Máquina Virtual foi parada. |
Status | Especifica o status da Máquina Virtual. |
VirtualIPs
Contém os endereços IP virtuais especificados para a implantação.
Nome do elemento | Descrição |
---|---|
Endereço | Especifica o endereço IP virtual da implantação. |
IsReserved | Indica se o endereço IP virtual está reservado. Os valores possíveis são: - true - false |
ReservedIPName | Especifica o nome de um endereço IP reservado que foi atribuído à implantação. |
Type | Especifica um valor de Private se o endereço de IP virtual estiver associado a um balanceador de carga interno. |
SubnetNames
Contém uma lista de sub-redes às quais a Máquina Virtual pertencerá.
Nome do elemento | Descrição |
---|---|
SubnetName | Obrigatórios. Especifica o nome de uma sub-rede à qual a Máquina Virtual pertence. |
DataVirtualHardDisks
Contém os parâmetros que são usados para adicionar um disco de dados a uma Máquina Virtual.
Nome do elemento | Descrição |
---|---|
HostCaching | Especifica o comportamento do cache da plataforma de blob de disco de dados para a eficiência de leitura/gravação. Os valores possíveis são: - None - ReadOnly - ReadWrite O valor padrão é ReadOnly . |
DiskName | Especifica o nome do VHD a ser usado para criar o disco de dados para a Máquina Virtual. |
Lun | Especifica o Número de Unidade Lógica (LUN) para o disco de dados. O LUN especifica o local em que a unidade de dados aparece quando montada para uso pela Máquina Virtual. Este elemento só será listado quando mais de um disco de dados for anexado a uma Máquina Virtual. Os valores válidos são 0 a 31. |
LogicalDiskSizeInGB | Especifica o tamanho, em GB, do disco a ser anexado à Máquina Virtual. |
MediaLink | Especifica a localização do VHD associado ao disco no armazenamento do Azure. Exemplo: http://example.blob.core.windows.net/disks/mydatadisk.vhd| |
IOType | Essa propriedade identifica o tipo da conta de armazenamento para backup no VHD. Se o VHD de suporte estiver em uma conta de Armazenamento Provisionado, "Provisionado" será retornado caso contrário, "Standard" será retornado. Observação: esse valor é preenchido pela plataforma do Azure quando o disco é criado, não pelo usuário. Essa propriedade só será retornada com um cabeçalho de versão de 2014-10-01 ou mais recente. |
OSVirtualHardDisk
Contém os parâmetros que são usados para criar o disco do sistema operacional para uma Máquina Virtual.
Nome do elemento | Descrição |
---|---|
HostCaching | Especifica o comportamento de cache de plataforma do blob de disco do sistema operacional para a eficiência de leitura/gravação. Os valores possíveis são: - ReadOnly - ReadWrite |
DiskName | Especifica o nome de uma imagem do sistema operacional no repositório de imagens. |
MediaLink | Especifica a localização do VHD associado ao disco do sistema operacional no armazenamento do Azure. |
SourceImageName | Especifica o nome da imagem de origem usada para criar o disco do sistema operacional. |
Sistema operacional | Especifica o sistema operacional que está em execução na Máquina Virtual. Os valores possíveis são: - Windows - Linux |
RemoteSourceImageLink | Especifica um URI para o local onde uma imagem do sistema operacional foi armazenada que é usada para criar a máquina virtual. Esse local pode ser um local diferente do usuário ou repositórios de plataforma no Azure. Uma imagem é sempre associada a um VHD, que é um arquivo .vhd armazenado como um blob de páginas em uma conta de armazenamento. Se você especificar o caminho para uma imagem com esse elemento, um VHD associado será criado e você deverá usar o elemento MediaLink para especificar a localização no armazenamento onde o VHD estará localizado. Se esse elemento for usado, o SourceImageName não será usado. O RemoteSourceImageLink elemento só está disponível usando a versão 2014-05-01 ou superior. |
IOType | Essa propriedade identifica o tipo da conta de armazenamento para backup no VHD. Se o backup VHD estiver em uma conta de armazenamento provisionado, “Provisionado” é retornado. Caso contrário, “Padrão” será retornado. Observação: esse valor é preenchido pela plataforma do Azure quando o disco é criado, não pelo usuário. Essa propriedade só será retornada com um cabeçalho de versão de 2014-10-01 ou mais recente. |
ResourceExtensionReferences
Contém uma coleção de extensões de recurso que serão instaladas na Máquina Virtual. Uma extensão de recurso é um componente de software instalado na Máquina Virtual. O VM Agent deve ser instalado na máquina virtual para instalar as extensões de recursos.
Nome do elemento | Descrição |
---|---|
ResourceExtensionReference | Obrigatórios. Especifica as propriedades de uma extensão de recurso que deve ser instalada na Máquina Virtual. |
ReferenceName | Obrigatórios. Especifica o nome de referência da extensão de recurso. |
Publicador | Obrigatórios. Especifica o nome do publicador que criou a extensão de recurso. Você pode usar Listar Extensões de Recursos para localizar o nome do editor de uma extensão de recurso. |
Nome | Obrigatórios. Especifica o nome da extensão de recurso. Você pode usar Listar Extensões de Recursos para localizar os nomes das extensões de recursos disponíveis. |
Versão | Obrigatórios. Especifica a versão da extensão de recurso. Você pode usar Listar Versões de Extensão de Recurso para localizar a versão da extensão de recurso. |
ResourceExtensionParameterValues | Opcional. Contém uma coleção de parâmetros que são passados para a extensão de recurso quando ela é instalada. |
Estado | Opcional. Especifica o estado da extensão de recurso. Os valores possíveis são: - Enable - Disable O valor padrão é Enable . |
ResourceExtensionParameterValues
Contém uma coleção de parâmetros que são passados para a extensão de recurso quando ela é instalada.
Nome do elemento | Descrição |
---|---|
ResourceExtensionParameterValue | Obrigatórios. Especifica a chave, o valor e o tipo do parâmetro. |
Chave | Obrigatórios. Especifica a chave do parâmetro. |
Valor | Obrigatórios. Especifica o valor codificado na base 64 do parâmetro. |
Type | Obrigatórios. Especifica o tipo da extensão de recurso. Os valores possíveis são: - Public - Private Se esse valor for definido como Private , o parâmetro não será retornado por Get Deployment. Você só pode especificar um parâmetro público e um parâmetro privado para um máximo de dois parâmetros. |
ExtensionConfiguration
Contém extensões que são adicionadas ao serviço de nuvem.
Nome do elemento | Descrição |
---|---|
AllRoles | Especifica uma lista de extensões aplicadas a todas as funções em uma implantação. |
Extensão | Especifica uma extensão que deve ser implantada em uma função em um serviço de nuvem. |
NamedRoles | Especifica uma lista de extensões aplicadas a funções específicas em uma implantação. |
Extensão
Especifica uma extensão que deve ser implantada em uma função em um serviço de nuvem.
Nome do elemento | Descrição |
---|---|
ID | Especifica o identificador da extensão. O identificador é criado quando a extensão é adicionada ao serviço de nuvem. Você pode encontrar a ID de uma extensão que foi adicionada a um serviço de nuvem usando extensões de lista. |
SequenceNumber | Especifica o número da última configuração aplicada para a extensão. Esse número é atribuído pelo Azure e é incrementado a cada mudança de configuração. O SequenceNumber elemento só está disponível usando a versão 2014-06-01 ou superior. |
Estado | Opcional. Especifica o status da extensão. Este elemento só se aplica a extensões configuradas JSON. Os valores possíveis são: - Enable - Disable - Uninstall O valor padrão é Enable .O State elemento só está disponível usando a versão 2014-06-01 ou superior. |
NamedRoles
Especifica uma lista de extensões aplicadas a funções específicas em uma implantação.
Nome do elemento | Descrição |
---|---|
Função | Especifica uma função específica à qual a extensão é adicionada. |
RoleName | Especifica o nome da função. |
Extensão | Especifica uma extensão que deve ser implantada em uma função em um serviço de nuvem. |
GuestAgentStatus
Especifica informações sobre o agente instalado em uma instância.
Nome do elemento | Descrição |
---|---|
ProtocolVersion | Especifica a versão do protocolo usado pelo agente para comunicar o status. |
Timestamp | Especifica a hora em formato UTC em que o status foi comunicado. |
GuestAgentVersion | Especifica a versão do agente instalada na instância. |
Status | Especifica o status do agente. Os valores possíveis são: - Ready - NotReady |
FormattedMessage | Especifica uma mensagem de status localizada. |
FormattedMessage
Especifica uma mensagem de status localizada.
Nome do elemento | Descrição |
---|---|
Idioma | Especifica a linguagem da mensagem. |
Mensagem | Especifica a mensagem. |
ResourceExtensionStatusList
Especifica informações sobre as extensões instaladas em uma instância.
Nome do elemento | Descrição |
---|---|
ResourceExtensionStatus | Especifica informações sobre determinada extensão. |
ResourceExtensionStatus
Especifica informações sobre determinada extensão.
Nome do elemento | Descrição |
---|---|
HandlerName | Especifica o nome da extensão. |
Versão | Especifica a versão da extensão. |
Status | Especifica o status da extensão. Os valores possíveis são: - Installing - Ready - NotReady - Unresponsive |
Código | Especifica o código de status retornado pela extensão. |
FormattedMessage | Especifica uma mensagem de status localizada. |
ExtensionSettingStatus | Especifica as informações de status sobre as configurações que foram passadas para a extensão. |
PublicIPs
Contém um endereço IP público que pode ser usado em conjunto com o padrão de endereço IP virtual para a máquina virtual.
Nome do elemento | Descrição |
---|---|
PublicIP | Obrigatórios. Especifica um endereço IP público adicional que pode ser usado para se comunicar com a máquina virtual. |
Nome | Obrigatórios. Especifica o nome do endereço IP público. |
Endereço | Obrigatórios. Especifica o endereço IP do IP público. |
IdleTimeoutInMinutes | Opcional. Especifica o tempo limite para a conexão TCP ociosa. O valor pode ser definido entre 4 e 30 minutos. O valor padrão é 4 minutos. Este elemento é utilizado apenas quando o protocolo é definido como TCP. O IdleTimeoutInMinutes elemento só está disponível usando a versão 2014-06-01 ou superior. |
DomainNameLabel | Opcional. Especifica o rótulo de nome de domínio do IP público. O DomainNameLabel elemento só está disponível usando a versão 2015-03-01 ou superior. |
Fqdn | Opcional. Especifica um FQDN registrado para esse IP público. |
NetworkInterfaces
Contém um conjunto de interfaces de rede secundárias.
Nome do elemento | Descrição |
---|---|
NetworkInterface | Obrigatórios. Especifica uma interface de rede secundária. |
Nome | Obrigatório, especifica o nome da interface de rede secundária. |
IPConfigurations | Obrigatórios. Especifica um conjunto de configurações de endereços IP para uma interface de rede secundária. |
IPConfigurations
Especifica um conjunto de configurações de endereços IP para uma interface de rede secundária.
Nome do elemento | Descrição |
---|---|
IPConfiguration | Obrigatórios. Especifica uma configuração de endereços IP para uma interface de rede secundária. No momento, apenas uma configuração de endereço IP tem suporte para uma interface de rede secundária. |
SubnetName | Obrigatórios. Especifica o nome da sub-rede da rede virtual à qual pertence essa configuração de endereço IP. |
Endereço | Obrigatório, especifica o endereço IP interno configurado para uma interface de rede secundária. |
LoadBalancers
Contém uma lista de balanceadores de carga internos que podem ser atribuídos a pontos de extremidade de entrada.
Nome do elemento | Descrição |
---|---|
LoadBalancer | Obrigatórios. Especifica os atributos de um balanceador de carga interno. |
Nome | Obrigatórios. Especifica o nome de um balanceador de carga interno. |
FrontendIpConfiguration | Obrigatórios. Especifica a configuração para o endereço IP virtual que é fornecido pelo balanceador de carga. |
Type | Obrigatórios. Especifica o tipo de endereço IP virtual que é fornecido pelo balanceador de carga. O único valor permitido é Private . |
SubnetName | Necessário se a implantação existir em uma rede virtual e um StaticVirtualNetworkIPAddress for atribuído. Especifica a sub-rede da rede virtual que o balanceador de carga usa. O endereço IP virtual que é gerido pelo balanceador de carga está contido nessa sub-rede. |
StaticVirtualNetworkIPAddress | Opcional. Especifica um endereço IP virtual específico que o balanceador de carga usa da sub-rede na rede virtual. |
ExtensionSettingStatus
Especifica as informações de status sobre as configurações que foram passadas para a extensão.
Nome do elemento | Descrição |
---|---|
Timestamp | Especifica a hora em formato UTC em que o status foi comunicado. |
Nome | Especifica o nome da configuração que foi passada para a extensão. |
Operação | Especifica a operação que foi efetuada pela extensão usando a configuração. |
Status | Especifica o status da operação. Os valores possíveis são: - transitioning - error - success - warning |
Código | Especifica o código de status da operação. |
FormattedMessage | Especifica uma mensagem de status localizada. |
SubStatusList | Contém uma lista de informações adicionais sobre o estado, se existir. |
SubStatusList
Contém uma lista de informações adicionais sobre o estado, se existir.
Nome do elemento | Descrição |
---|---|
SubStatus | Contém informações sobre as mensagens de status adicionais retornados pela extensão. |
Nome | Especifica o identificador de estado. |
Status | Especifica o status da operação. Os valores possíveis são: - transitioning - error - success - warning |
FormattedMessage | Especifica uma mensagem de status localizada. |
Comentários
Para obter os nomes dos serviços de nuvem em sua assinatura, você pode usar Listar Serviços de Nuvem.