Scope Access Review History Definition Instance - Generate Download Uri

Service:

Authorization

Version d'API:

2021-12-01-preview

Génère un URI qui peut être utilisé pour récupérer les données d’historique de révision. Cet URI a une durée de vie de 1 jour et peut être récupéré en récupérant l’objet accessReviewHistoryDefinition.

POST https://management.azure.com/{scope}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}/instances/{instanceId}/generateDownloadUri?api-version=2021-12-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
historyDefinitionId	path	True	string	ID de la définition de l’historique de révision d’accès.
instanceId	path	True	string	ID de l’instance de définition de l’historique de révision d’accès pour laquelle générer un URI.
scope	path	True	string	Étendue de la ressource.
api-version	query	True	string	Version de l’API à utiliser avec la requête HTTP.

Réponses

Nom	Type	Description
200 OK	AccessReviewHistoryInstance	AccessReviewHistoryInstance
Other Status Codes	ErrorDefinition	Erreur inattendue

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

PostAccessReviewHistoryDefinitionInstance

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/44724910-d7a5-4c29-b28f-db73e717165a/instances/9038f4f3-3d8d-43c3-8ede-669ea082c43b/generateDownloadUri?api-version=2021-12-01-preview

Go

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-12-01-preview/examples/PostAccessReviewHistoryDefinitionInstance.json
func ExampleScopeAccessReviewHistoryDefinitionInstanceClient_GenerateDownloadURI() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewScopeAccessReviewHistoryDefinitionInstanceClient().GenerateDownloadURI(ctx, "subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a", "44724910-d7a5-4c29-b28f-db73e717165a", "9038f4f3-3d8d-43c3-8ede-669ea082c43b", 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.AccessReviewHistoryInstance = armauthorization.AccessReviewHistoryInstance{
	// 	Name: to.Ptr("9038f4f3-3d8d-43c3-8ede-669ea082c43b"),
	// 	Type: to.Ptr("Microsoft.Authorization/accessReviewHistoryInstance"),
	// 	ID: to.Ptr("9038f4f3-3d8d-43c3-8ede-669ea082c43b"),
	// 	Properties: &armauthorization.AccessReviewHistoryInstanceProperties{
	// 		DisplayName: to.Ptr("Hello world name"),
	// 		DownloadURI: to.Ptr("https://dfermconsolreportusc.blob.core.windows.net/df-erm-reports/Hello world name-22be232e-a93d-42a3-8ac5-313cfd29a0eb.csv?sv=2015-04-05&ss=b&srt=o&sp=rl&st=2021-03-22T19:39:38.0000000Z&se=2021-03-23T19:41:38.0000000Z&spr=https&sig=84rlGCIgU4ToMn%2FFLncBXq95O8a8RsFlwQY1Knl%2Fo%2FI%3D"),
	// 		Expiration: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-22T00:28:33.690Z"); return t}()),
	// 		FulfilledDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-23T00:28:33.690Z"); return t}()),
	// 		ReviewHistoryPeriodEndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-01T08:00:00.000Z"); return t}()),
	// 		ReviewHistoryPeriodStartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-01T07:00:00.000Z"); return t}()),
	// 		RunDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-12-23T00:27:33.690Z"); return t}()),
	// 		Status: to.Ptr(armauthorization.AccessReviewHistoryDefinitionStatusRequested),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object.
 *
 * @summary Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-12-01-preview/examples/PostAccessReviewHistoryDefinitionInstance.json
 */
async function postAccessReviewHistoryDefinitionInstance() {
  const scope = "subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a";
  const historyDefinitionId = "44724910-d7a5-4c29-b28f-db73e717165a";
  const instanceId = "9038f4f3-3d8d-43c3-8ede-669ea082c43b";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.scopeAccessReviewHistoryDefinitionInstance.generateDownloadUri(
    scope,
    historyDefinitionId,
    instanceId
  );
  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

Exemple de réponse

Code d’état:

200

{
  "id": "9038f4f3-3d8d-43c3-8ede-669ea082c43b",
  "name": "9038f4f3-3d8d-43c3-8ede-669ea082c43b",
  "type": "Microsoft.Authorization/accessReviewHistoryInstance",
  "properties": {
    "reviewHistoryPeriodStartDateTime": "2021-10-01T00:00:00-07:00",
    "reviewHistoryPeriodEndDateTime": "2021-12-01T00:00:00-08:00",
    "displayName": "Hello world name",
    "status": "Requested",
    "runDateTime": "2021-12-23T00:27:33.6905189+00:00",
    "fulfilledDateTime": "2021-12-23T00:28:33.6905189+00:00",
    "downloadUri": "https://dfermconsolreportusc.blob.core.windows.net/df-erm-reports/Hello world name-22be232e-a93d-42a3-8ac5-313cfd29a0eb.csv?sv=2015-04-05&ss=b&srt=o&sp=rl&st=2021-03-22T19:39:38.0000000Z&se=2021-03-23T19:41:38.0000000Z&spr=https&sig=84rlGCIgU4ToMn%2FFLncBXq95O8a8RsFlwQY1Knl%2Fo%2FI%3D",
    "expiration": "2022-01-22T00:28:33.6905189+00:00"
  }
}

Définitions

Nom	Description
AccessReviewHistoryDefinitionStatus	Ce champ en lecture seule spécifie les données d’historique de révision demandées. Cela est demandé, en cours, effectué ou une erreur.
AccessReviewHistoryInstance	Instance de définition de l’historique de révision d’accès.
ErrorDefinition	Erreur
ErrorDefinitionProperties	Erreur

AccessReviewHistoryDefinitionStatus

Énumération

Ce champ en lecture seule spécifie les données d’historique de révision demandées. Cela est demandé, en cours, effectué ou une erreur.

Valeur	Description
Done
Error
InProgress
Requested

AccessReviewHistoryInstance

Object

Instance de définition de l’historique de révision d’accès.

Nom	Type	Description
id	string	ID d’instance de définition de l’historique de révision d’accès.
name	string	ID unique de l’instance de définition de l’historique de révision d’accès.
properties.displayName	string	Nom complet de la définition de l’historique parent.
properties.downloadUri	string	Uri qui peut être utilisé pour récupérer les données d’historique de révision. Pour générer cet URI, generateDownloadUri() doit être appelé pour un accessReviewHistoryDefinitionInstance spécifique. Le lien expire après une période de 24 heures. Les appelants peuvent voir l’heure de date d’expiration en examinant le paramètre « se » dans l’URI généré.
properties.expiration	string (date-time)	Date d’expiration du rapport de données d’historique et suppression des données associées.
properties.fulfilledDateTime	string (date-time)	Heure à laquelle le rapport de données d’historique est planifié pour être généré.
properties.reviewHistoryPeriodEndDateTime	string (date-time)	Date utilisée lors de la sélection des données de révision, toutes les révisions incluses dans les données se terminent ou avant cette date. Pour une utilisation uniquement avec des rapports ponctuels/non périodiques.
properties.reviewHistoryPeriodStartDateTime	string (date-time)	Date utilisée lors de la sélection des données de révision, toutes les révisions incluses dans les données commencent ou après cette date. Pour une utilisation uniquement avec des rapports ponctuels/non périodiques.
properties.runDateTime	string (date-time)	Heure à laquelle le rapport de données d’historique est planifié pour être généré.
properties.status	AccessReviewHistoryDefinitionStatus	État des données d’instance de l’historique de révision demandées. Cela est demandé, en cours, effectué ou une erreur. Les transitions d’état sont les suivantes : Demandé -> InProgress -> Terminé -> Expiré
type	string	Type de ressource.

ErrorDefinition

Object

Erreur

Nom	Type	Description
error	ErrorDefinitionProperties	Erreur Erreur de l’état de la passerelle de liste.

ErrorDefinitionProperties

Object

Erreur

Nom	Type	Description
code	string	Code d’erreur de la passerelle de liste.
message	string	Description de l’erreur.