Guest Configuration Connected VM warev Sphere Assignments Reports - Get

Serviço:: Guest Configuration

Versão da API:: 2024-04-05

Obtenha um relatório para a atribuição de configuração de convidado, por reportId.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}?api-version=2024-04-05

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
guestConfigurationAssignmentName	path	True	string pattern: ^[^<>%&:\\?/#]*$	O nome da atribuição de configuração de convidado.
reportId	path	True	string	O GUID para o relatório de atribuição de configuração de convidado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
vmName	path	True	string pattern: ^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$	O nome da máquina virtual.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	GuestConfigurationAssignmentReport	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a guest configuration assignment report by Id for a virtual machine

Solicitação de exemplo

GET https://management.azure.com/subscriptions/mySubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.ConnectedVMwarevSphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1?api-version=2024-04-05

from azure.identity import DefaultAzureCredential

from azure.mgmt.guestconfig import GuestConfigurationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-guestconfig
# USAGE
    python get_guest_configuration_connected_vmwarev_sphere_assignment_report_by_id.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = GuestConfigurationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.guest_configuration_connected_vmwarev_sphere_assignments_reports.get(
        resource_group_name="myResourceGroupName",
        vm_name="myvm",
        guest_configuration_assignment_name="AuditSecureProtocol",
        report_id="7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    )
    print(response)


# x-ms-original-file: 2024-04-05/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armguestconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration/v2"
)

// Generated from example definition: 2024-04-05/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json
func ExampleConnectedVMwarevSphereAssignmentsReportsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armguestconfiguration.NewClientFactory("mySubscriptionid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectedVMwarevSphereAssignmentsReportsClient().Get(ctx, "myResourceGroupName", "myvm", "AuditSecureProtocol", "7367cbb8-ae99-47d0-a33b-a283564d2cb1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armguestconfiguration.ConnectedVMwarevSphereAssignmentsReportsClientGetResponse{
	// 	AssignmentReport: armguestconfiguration.AssignmentReport{
	// 		Name: to.Ptr("7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 		ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 		Properties: &armguestconfiguration.AssignmentReportProperties{
	// 			Assignment: &armguestconfiguration.AssignmentInfo{
	// 				Name: to.Ptr("AuditSecureProtocol"),
	// 				Configuration: &armguestconfiguration.ConfigurationInfo{
	// 					Name: to.Ptr("AuditSecureProtocol"),
	// 					Version: to.Ptr("1.0.0.0"),
	// 				},
	// 			},
	// 			ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:14:13Z"); return t}()),
	// 			ReportID: to.Ptr("7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:13:53Z"); return t}()),
	// 			VM: &armguestconfiguration.VMInfo{
	// 				ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm"),
	// 				UUID: to.Ptr("vmuuid"),
	// 			},
	// 			Details: &armguestconfiguration.AssignmentReportDetails{
	// 				ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:14:13Z"); return t}()),
	// 				JobID: to.Ptr("7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 				OperationType: to.Ptr(armguestconfiguration.TypeConsistency),
	// 				Resources: []*armguestconfiguration.AssignmentReportResource{
	// 					{
	// 						ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 						Properties: map[string]any{
	// 							"ConfigurationName": "IsWebServerSecure",
	// 							"DependsOn": nil,
	// 							"IsSingleInstance": "Yes",
	// 							"ModuleName": "SecureProtocolWebServer",
	// 							"ModuleVersion": "1.0.0.3",
	// 							"Protocols": []any{
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "SSL 2.0",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "SSL 3.0",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "TLS 1.0",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "PCT 1.0",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "Multi-Protocol Unified Hello",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "TLS 1.1",
	// 								},
	// 								map[string]any{
	// 									"Ensure": "Absent",
	// 									"Protocol": "TLS 1.2",
	// 								},
	// 							},
	// 							"PsDscRunAsCredential": nil,
	// 							"Reasons": nil,
	// 							"ResourceId": "[SecureWebServer]s1",
	// 							"SourceInfo": nil,
	// 						},
	// 						Reasons: []*armguestconfiguration.AssignmentReportResourceComplianceReason{
	// 							{
	// 								Code: to.Ptr("DSC::RESOURCE::SUCCESS"),
	// 								Phrase: to.Ptr("Operation successful."),
	// 							},
	// 						},
	// 					},
	// 				},
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:13:53Z"); return t}()),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { GuestConfigurationClient } = require("@azure/arm-guestconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get a report for the guest configuration assignment, by reportId.
 *
 * @summary get a report for the guest configuration assignment, by reportId.
 * x-ms-original-file: 2024-04-05/getGuestConfigurationConnectedVMwarevSphereAssignmentReportById.json
 */
async function getAGuestConfigurationAssignmentReportByIdForAVirtualMachine() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "mySubscriptionid";
  const client = new GuestConfigurationClient(credential, subscriptionId);
  const result = await client.guestConfigurationConnectedVMwarevSphereAssignmentsReports.get(
    "myResourceGroupName",
    "myvm",
    "AuditSecureProtocol",
    "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
  "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
  "properties": {
    "assignment": {
      "name": "AuditSecureProtocol",
      "configuration": {
        "name": "AuditSecureProtocol",
        "version": "1.0.0.0"
      }
    },
    "complianceStatus": "Compliant",
    "endTime": "2018-08-29T22:14:13Z",
    "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    "startTime": "2018-08-29T22:13:53Z",
    "vm": {
      "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Connectedvmwarevsphere/virtualmachines/myvm",
      "uuid": "vmuuid"
    },
    "details": {
      "complianceStatus": "Compliant",
      "endTime": "2018-08-29T22:14:13Z",
      "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
      "operationType": "Consistency",
      "resources": [
        {
          "complianceStatus": "Compliant",
          "properties": {
            "ConfigurationName": "IsWebServerSecure",
            "DependsOn": null,
            "IsSingleInstance": "Yes",
            "ModuleName": "SecureProtocolWebServer",
            "ModuleVersion": "1.0.0.3",
            "Protocols": [
              {
                "Ensure": "Absent",
                "Protocol": "SSL 2.0"
              },
              {
                "Ensure": "Absent",
                "Protocol": "SSL 3.0"
              },
              {
                "Ensure": "Absent",
                "Protocol": "TLS 1.0"
              },
              {
                "Ensure": "Absent",
                "Protocol": "PCT 1.0"
              },
              {
                "Ensure": "Absent",
                "Protocol": "Multi-Protocol Unified Hello"
              },
              {
                "Ensure": "Absent",
                "Protocol": "TLS 1.1"
              },
              {
                "Ensure": "Absent",
                "Protocol": "TLS 1.2"
              }
            ],
            "PsDscRunAsCredential": null,
            "Reasons": null,
            "ResourceId": "[SecureWebServer]s1",
            "SourceInfo": null
          },
          "reasons": [
            {
              "code": "DSC::RESOURCE::SUCCESS",
              "phrase": "Operation successful."
            }
          ]
        }
      ],
      "startTime": "2018-08-29T22:13:53Z"
    }
  }
}

Definições

Nome	Description
AssignmentInfo	Informações sobre a atribuição de configuração de convidado.
AssignmentReportDetails	Detalhes do relatório de atribuição de configuração de convidado.
AssignmentReportResource	O recurso de atribuição de configuração de convidado.
AssignmentReportResourceComplianceReason	Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.
ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
ConfigurationInfo	Informações sobre a configuração.
Error
ErrorResponse	Resposta de erro de uma falha de operação.
GuestConfigurationAssignmentReport	Relatório da atribuição de configuração de convidado. O relatório contém informações como status de conformidade, motivo e muito mais.
GuestConfigurationAssignmentReportProperties	Relatório da atribuição de configuração de convidado. O relatório contém informações como status de conformidade, motivo e muito mais.
Type	Tipo de relatório, consistência ou inicial
VMInfo	Informações sobre a VM.

AssignmentInfo

Objeto

Informações sobre a atribuição de configuração de convidado.

Nome	Tipo	Description
configuration	ConfigurationInfo	Informações sobre a configuração.
name	string	Nome da atribuição de configuração de convidado.

AssignmentReportDetails

Objeto

Detalhes do relatório de atribuição de configuração de convidado.

Nome	Tipo	Description
complianceStatus	ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
endTime	string (date-time)	Data e hora de término da verificação de status de conformidade da atribuição de configuração de convidado.
jobId	string	GUID do relatório.
operationType	Type	Tipo de relatório, consistência ou inicial
resources	AssignmentReportResource[]	A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada.
startTime	string (date-time)	Data e hora de início da verificação de status de conformidade da atribuição de configuração de convidado.

AssignmentReportResource

Objeto

O recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
complianceStatus	ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
properties		Propriedades de um recurso de atribuição de configuração de convidado.
reasons	AssignmentReportResourceComplianceReason[]	Motivo de conformidade e código de motivo para um recurso.
resourceId	string	Nome da configuração de recurso de atribuição de configuração de convidado.

AssignmentReportResourceComplianceReason

Objeto

Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
code	string	Código para a conformidade do recurso de atribuição de configuração de convidado.
phrase	string	Motivo para a conformidade do recurso de atribuição de configuração de convidado.

ComplianceStatus

Enumeração

Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.

Valor	Description
Compliant
NonCompliant
Pending

ConfigurationInfo

Objeto

Informações sobre a configuração.

Nome	Tipo	Description
name	string	Nome da configuração.
version	string	Versão da configuração.

Error

Objeto

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro de detalhe indicando por que a operação falhou.

ErrorResponse

Objeto

Resposta de erro de uma falha de operação.

Nome	Tipo	Description
error	Error

GuestConfigurationAssignmentReport

Objeto

Relatório da atribuição de configuração de convidado. O relatório contém informações como status de conformidade, motivo e muito mais.

Nome	Tipo	Description
id	string	ID de recurso do ARM do relatório para a atribuição de configuração de convidado.
name	string	GUID que identifica o relatório de atribuição de configuração de convidado em uma assinatura, grupo de recursos.
properties	GuestConfigurationAssignmentReportProperties	Propriedades do relatório de configuração de convidado.

GuestConfigurationAssignmentReportProperties

Objeto

Relatório da atribuição de configuração de convidado. O relatório contém informações como status de conformidade, motivo e muito mais.

Nome	Tipo	Description
assignment	AssignmentInfo	Detalhes de configuração da atribuição de configuração de convidado.
complianceStatus	ComplianceStatus	Um valor que indica o status de conformidade do computador para a configuração de convidado atribuída.
details	AssignmentReportDetails	Detalhes do relatório de atribuição.
endTime	string (date-time)	Data e hora de término da verificação de status de conformidade da atribuição de configuração de convidado.
reportId	string	GUID que identifica o relatório de atribuição de configuração de convidado em uma assinatura, grupo de recursos.
startTime	string (date-time)	Data e hora de início da verificação de status de conformidade da atribuição de configuração de convidado.
vm	VMInfo	Informações sobre a VM.
vmssResourceId	string	ID de recurso do Azure do VMSS.

Type

Enumeração

Tipo de relatório, consistência ou inicial

Valor	Description
Consistency
Initial

VMInfo

Objeto

Informações sobre a VM.

Nome	Tipo	Description
id	string	ID de recurso do Azure da VM.
uuid	string	UUID(Identificador Universalmente Exclusivo) da VM.