@azure-rest/purview-sharing package
Schnittstellen
Typaliase
| Artifact |
Eine Klasse für gesendete Freigabeartefakte. |
| ArtifactOutput |
Eine Klasse für gesendete Freigabeartefakte. |
| GetArrayType |
Hilfstyp zum Extrahieren des Typs eines Arrays |
| GetPage |
Der Typ einer benutzerdefinierten Funktion, die definiert, wie eine Seite und ein Link zum nächsten abgerufen werden, falls vorhanden. |
| PaginateReturn |
Hilfstyp zum Ableiten des Typs der seitenseitigen Elemente vom Antworttyp Dieser Typ wird basierend auf den Waggerinformationen für x-ms-pageable speziell auf der itemName-Eigenschaft generiert, die die Eigenschaft der Antwort angibt, in der die Seitenelemente gefunden werden. Der Standardwert ist |
| PurviewSharingClient | |
| ReceivedShare |
Ein empfangenes Freigabedatenübertragungsobjekt. |
| ReceivedShareOutput |
Ein empfangenes Freigabedatenübertragungsobjekt. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Ein gesendetes Freigabedatenübertragungsobjekt. |
| SentShareInvitation |
Ein gesendetes Freigabe-Einladungs-Datenübertragungsobjekt. |
| SentShareInvitationOutput |
Ein gesendetes Freigabe-Einladungs-Datenübertragungsobjekt. |
| SentShareOutput |
Ein gesendetes Freigabedatenübertragungsobjekt. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Enthält Details zum Ziel des zugeordneten Artefakts. |
| SinkOutput |
Enthält Details zum Ziel des zugeordneten Artefakts. |
Functions
Details zur Funktion
default(string, TokenCredential, PurviewSharingClientOptions)
Initialisieren einer neuen Instanz von PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parameter
- endpoint
-
string
Der Freigabeendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
Eindeutige Identifizierung von Clientanmeldeinformationen
- options
- PurviewSharingClientOptions
der Parameter für alle optionalen Parameter
Gibt zurück
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Hilfsfunktion, mit der ein Poller-Objekt erstellt wird, um einen vorgang mit langer Ausführung abzufragen.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameter
- client
- Client
Client, der zum Senden der Anforderung zum Abrufen zusätzlicher Seiten verwendet werden soll.
- initialResponse
-
TResult
Die erste Antwort.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Optionen zum Festlegen eines Fortsetzungszustands oder eines benutzerdefinierten Abrufintervalls.
Gibt zurück
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Ein Poller-Objekt zum Abrufen von Vorgangsstatusaktualisierungen und schließlich zum Abrufen der endgültigen Antwort.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parameter
Gibt zurück
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die auf die Spezifikation der Erweiterung Autorest x-ms-pageable folgt
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parameter
- client
- Client
Client, der zum Senden der nächsten Seitenanforderungen verwendet werden soll
- initialResponse
-
TResponse
Ursprüngliche Antwort, die die nextLink- und aktuelle Seite von Elementen enthält
- options
-
PagingOptions<TResponse>
Gibt zurück
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator zum Durchlaufen der Elemente