Data.Cloud.AzureAPI.TAzureBlobService.SetContainerACL

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function SetContainerACL(ContainerName: string;  const SignedIdentifierId: string; AccessPolicy: TAccessPolicy; PublicAccess: TBlobPublicAccess = bpaContainer; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function SetContainerACL(const AContainerName: string; const ASignedIdentifierId: string;  const AAccessPolicy: TPolicy; APublicAccess: TBlobPublicAccess; const AClientRequestID: string; const AResponseInfo: TCloudResponseInfo): Boolean; overload; deprecated 'Use overloaded method instead';
function SetContainerACL(ContainerName: string;  SignedIdentifiers: TList<TSignedIdentifier>; PublicAccess: TBlobPublicAccess = bpaContainer; ResponseInfo: TCloudResponseInfo = nil; const AClientRequestID: string = ''): Boolean; overload; deprecated 'Use overloaded method instead';
function SetContainerACL(const AContainerName: string; ASignedIdentifiers: array of ISignedIdentifier;  const APublicAccess: TBlobPublicAccess; const AClientRequestID: string; const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++ 

bool __fastcall SetContainerACL _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, const System::UnicodeString SignedIdentifierId, const TAccessPolicy &AccessPolicy, TBlobPublicAccess PublicAccess = (TBlobPublicAccess)(0x1), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall SetContainerACL _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (const System::UnicodeString AContainerName, const System::UnicodeString ASignedIdentifierId, TPolicy* const AAccessPolicy, TBlobPublicAccess APublicAccess, const System::UnicodeString AClientRequestID, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;
bool __fastcall SetContainerACL _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::Generics::Collections::TList__1<TSignedIdentifier*>* SignedIdentifiers, TBlobPublicAccess PublicAccess = (TBlobPublicAccess)(0x1), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const System::UnicodeString AClientRequestID = System::UnicodeString())/* overload */;
bool __fastcall SetContainerACL(const System::UnicodeString AContainerName, _di_ISignedIdentifier *ASignedIdentifiers, const int ASignedIdentifiers_High, const TBlobPublicAccess APublicAccess, const System::UnicodeString AClientRequestID, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
 Data.Cloud.AzureAPI TAzureBlobService

Description

Sets the access policies stored for the specified blob container that you may use with shared access signatures, and returns True on success or False otherwise.

Note: When you establish a stored access policy on a blob container, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy fails with status code 403 (Forbidden), until the access policy becomes active.

SetContainerACL receives the following parameters:

  • AContainerName or ContainerName is the name of the target blob container.
  • You may specify either a single policy or several policies:
    • To specify a single access policy use the following parameters:
      • ASignedIdentifierId is a string that uniquely identifies the stored access policy.
      • AAccessPolicy is the access policy to store for the blob container.
    • To specify an array of access policies and their identifiers use the SignedIdentifiers parameter.
  • APublicAccess or PublicAccess is the value to set as the public access of the blob container. When you specify several access policies, it defaults to bpaContainer.
  • AClientRequestID is an optional string that uniquely identifies your client. This value is used for storage analytics.
  • AResponseInfo or ResponseInfo is an optional instance of TCloudResponseInfo to store the information of the response. Use a nil value if you do not need the information of the response.

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Sydney/e/index.php?title=Data.Cloud.AzureAPI.TAzureBlobService.SetContainerACL&oldid=747638"