Scope Access Review History Definition Instance - Generate Download Uri

Služba:

Authorization

Verze rozhraní API:

2021-12-01-preview

Vygeneruje identifikátor URI, který lze použít k načtení dat historie revizí. Tento identifikátor URI má hodnotu TTL 1 den a lze jej načíst načtením accessReviewHistoryDefinition objektu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
historyDefinitionId	path	True	string	ID definice historie kontroly přístupu.
instanceId	path	True	string	ID instance definice historie kontroly přístupu pro vygenerování identifikátoru URI pro.
scope	path	True	string	Rozsah prostředku.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Odpovědi

Name	Typ	Description
200 OK	AccessReviewHistoryInstance	AccessReviewHistoryInstance
Other Status Codes	ErrorDefinition	Neočekávaná chyba

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

PostAccessReviewHistoryDefinitionInstance

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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"
  }
}

Definice

Name	Description
AccessReviewHistoryDefinitionStatus	Toto pole jen pro čtení určuje požadovaná data historie kontroly. To se vyžaduje, probíhá, provádí se nebo dochází k chybě.
AccessReviewHistoryInstance	Instance definice historie kontroly přístupu
ErrorDefinition	Chyba
ErrorDefinitionProperties	Chyba

AccessReviewHistoryDefinitionStatus

Výčet

Toto pole jen pro čtení určuje požadovaná data historie kontroly. To se vyžaduje, probíhá, provádí se nebo dochází k chybě.

Hodnota	Description
Done
Error
InProgress
Requested

AccessReviewHistoryInstance

Objekt

Instance definice historie kontroly přístupu

Name	Typ	Description
id	string	ID instance definice definice historie kontroly přístupu.
name	string	Jedinečné ID instance definice historie kontroly přístupu.
properties.displayName	string	Zobrazovaný název definice nadřazené historie.
properties.downloadUri	string	Identifikátor URI, který lze použít k načtení dat historie revizí. Chcete-li vygenerovat tento identifikátor URI, musí být volána generateDownloadUri() pro konkrétní accessReviewHistoryDefinitionInstance. Platnost odkazu vyprší po 24hodinovém období. Volající uvidí datum vypršení platnosti tak, že se vygenerovaném identifikátoru URI podívá na parametr se.
properties.expiration	string (date-time)	Datum a čas vypršení platnosti sestavy dat historie a odstranění přidružených dat
properties.fulfilledDateTime	string (date-time)	Datum a čas, kdy je naplánováno generování sestavy dat historie
properties.reviewHistoryPeriodEndDateTime	string (date-time)	Datum a čas použitý při výběru revizí dat, všechny recenze zahrnuté v datech končí nebo před tímto datem. Pro použití pouze s jednorázovými nebo neopakujícími sestavami.
properties.reviewHistoryPeriodStartDateTime	string (date-time)	Datum a čas použitý při výběru kontrol dat, všechna recenze zahrnutá v datech začínají dne nebo po tomto datu. Pro použití pouze s jednorázovými nebo neopakujícími sestavami.
properties.runDateTime	string (date-time)	Datum a čas, kdy je naplánováno generování sestavy dat historie
properties.status	AccessReviewHistoryDefinitionStatus	Stavpožadovaných To se vyžaduje, probíhá, provádí se nebo dochází k chybě. Přechody stavu jsou následující – Požadováno –> InProgress –> Hotovo –> Vypršela platnost.
type	string	Typ prostředku.

ErrorDefinition

Objekt

Chyba

Name	Typ	Description
error	ErrorDefinitionProperties	Chyba Chyba stavu brány seznamu

ErrorDefinitionProperties

Objekt

Chyba

Name	Typ	Description
code	string	Kód chyby brány seznamu
message	string	Popis chyby