ResourceGraphClient class
- Rozszerzenie
Konstruktory
| Resource |
Inicjuje nowe wystąpienie klasy ResourceGraphClient. |
Właściwości
| operations |
Właściwości dziedziczone
| accept |
|
| credentials | |
| long |
Limit czasu ponawiania próby w sekundach dla długotrwałych operacji. Wartość domyślna to 30. |
Metody
Metody dziedziczone
| begin |
Wyślij początkowe żądanie LRO (długotrwała operacja) i wróć do httpLongRunningOperationResponse, który udostępnia metody sondowania LRO i sprawdzanie, czy LRO zostało zakończone. |
| restore |
Przywróć LROPoller z podanego LROPollState. Tej metody można użyć do ponownego utworzenia LROPoller na innym procesie lub maszynie. |
| send |
Udostępnia mechanizm tworzenia żądania, który będzie sondować i dostarczać wynik końcowy. |
| send |
Wyślij początkowe żądanie LRO (długotrwała operacja) i wróć do LROPoller, który udostępnia metody sondowania LRO I sprawdzania, czy LRO zostało zakończone. |
| send |
Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec. |
| send |
Wyślij podany element httpRequest. |
Szczegóły konstruktora
ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)
Inicjuje nowe wystąpienie klasy ResourceGraphClient.
new ResourceGraphClient(credentials: ServiceClientCredentials | TokenCredential, options?: ResourceGraphClientOptions)Parametry
- credentials
Poświadczenia potrzebne klientowi do nawiązania połączenia z platformą Azure. Zalecane są poświadczenia implementowania interfejsu TokenCredential z pakietu @azure/identity. Aby uzyskać więcej informacji na temat tych poświadczeń, zobacz https://www.npmjs.com/package/@azure/identity. Obsługiwane są również poświadczenia implementowania interfejsu ServiceClientCredentials ze starszych pakietów @azure/ms-rest-nodeauth i @azure/ms-rest-browserauth.
- options
- ResourceGraphClientOptions
Opcje parametrów
Szczegóły właściwości
operations
Szczegóły właściwości dziedziczonej
acceptLanguage
acceptLanguage: stringWartość właściwości
string
dziedziczone zResourceGraphClientContext.acceptLanguage
credentials
credentials: ServiceClientCredentials | TokenCredentialWartość właściwości
dziedziczone zResourceGraphClientContext.credentials
longRunningOperationRetryTimeout
Limit czasu ponawiania próby w sekundach dla długotrwałych operacji. Wartość domyślna to 30.
longRunningOperationRetryTimeout?: numberWartość właściwości
number
dziedziczone zResourceGraphClientContext.longRunningOperationRetryTimeout
Szczegóły metody
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)
Pobierz szczegóły zmiany zasobu.
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangeDetailsResponse>Parametry
- parameters
- ResourceChangeDetailsRequestParameters
Parametry dla tego żądania dotyczące szczegółów zmiany zasobu.
- options
- RequestOptionsBase
Parametry opcjonalne
Zwraca
Promise<ResourceChangeDetailsResponse>
Promise<Models.ResourceChangeDetailsResponse>
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeData[]>)Parametry
- parameters
- ResourceChangeDetailsRequestParameters
Parametry dla tego żądania dotyczące szczegółów zmiany zasobu.
- options
- RequestOptionsBase
Parametry opcjonalne
- callback
Wywołanie zwrotne
resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, callback: ServiceCallback<ResourceChangeData[]>)Parametry
- parameters
- ResourceChangeDetailsRequestParameters
Parametry dla tego żądania dotyczące szczegółów zmiany zasobu.
- callback
Wywołanie zwrotne
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)
Wyświetlanie listy zmian w zasobie dla danego interwału czasu.
function resourceChanges(parameters: ResourceChangesRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangesResponse>Parametry
- parameters
- ResourceChangesRequestParameters
parametry dla tego żądania zmian.
- options
- RequestOptionsBase
Parametry opcjonalne
Zwraca
Promise<ResourceChangesResponse>
Promise<Models.ResourceChangesResponse>
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeList>)Parametry
- parameters
- ResourceChangesRequestParameters
parametry dla tego żądania zmian.
- options
- RequestOptionsBase
Parametry opcjonalne
- callback
Wywołanie zwrotne
resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, callback: ServiceCallback<ResourceChangeList>)Parametry
- parameters
- ResourceChangesRequestParameters
parametry dla tego żądania zmian.
- callback
Wywołanie zwrotne
resources(QueryRequest, RequestOptionsBase)
Wysyła zapytania do zasobów zarządzanych przez usługę Azure Resource Manager pod kątem zakresów określonych w żądaniu.
function resources(query: QueryRequest, options?: RequestOptionsBase): Promise<ResourcesResponse>Parametry
- query
- QueryRequest
Żądanie określenia zapytania i jego opcji.
- options
- RequestOptionsBase
Parametry opcjonalne
Zwraca
Promise<ResourcesResponse>
Promise Models.ResourcesResponse<>
resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, options: RequestOptionsBase, callback: ServiceCallback<QueryResponse>)Parametry
- query
- QueryRequest
Żądanie określenia zapytania i jego opcji.
- options
- RequestOptionsBase
Parametry opcjonalne
- callback
Wywołanie zwrotne
resources(QueryRequest, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, callback: ServiceCallback<QueryResponse>)Parametry
- query
- QueryRequest
Żądanie określenia zapytania i jego opcji.
- callback
Wywołanie zwrotne
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)
Wyświetl listę wszystkich migawek zasobu dla danego interwału czasu.
function resourcesHistory(request: ResourcesHistoryRequest, options?: RequestOptionsBase): Promise<ResourcesHistoryResponse>Parametry
- request
- ResourcesHistoryRequest
- options
- RequestOptionsBase
Parametry opcjonalne
Zwraca
Promise<ResourcesHistoryResponse>
Promise<Models.ResourcesHistoryResponse>
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase, ServiceCallback<any>)
function resourcesHistory(request: ResourcesHistoryRequest, options: RequestOptionsBase, callback: ServiceCallback<any>)Parametry
- request
- ResourcesHistoryRequest
- options
- RequestOptionsBase
Parametry opcjonalne
- callback
-
ServiceCallback<any>
Wywołanie zwrotne
resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)
function resourcesHistory(request: ResourcesHistoryRequest, callback: ServiceCallback<any>)Parametry
- request
- ResourcesHistoryRequest
- callback
-
ServiceCallback<any>
Wywołanie zwrotne
Szczegóły metody dziedziczonej
beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Wyślij początkowe żądanie LRO (długotrwała operacja) i wróć do httpLongRunningOperationResponse, który udostępnia metody sondowania LRO i sprawdzanie, czy LRO zostało zakończone.
function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>Parametry
- request
Obiekt żądania
- options
- RequestOptionsBase
Dodatkowe opcje do wysłania podczas wysyłania żądania
Zwraca
Promise<@azure/ms-rest-azure-js.LROPoller>
HttpLongRunningOperationResponse, który udostępnia metody interakcji z LRO.
dziedziczone zResourceGraphClientContext.beginLongRunningRequest
restoreLROPoller(LROPollState)
Przywróć LROPoller z podanego LROPollState. Tej metody można użyć do ponownego utworzenia LROPoller na innym procesie lub maszynie.
function restoreLROPoller(lroPollState: LROPollState): LROPollerParametry
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
Zwraca
dziedziczone zResourceGraphClientContext.restoreLROPoller
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Udostępnia mechanizm tworzenia żądania, który będzie sondować i dostarczać wynik końcowy.
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>Parametry
- request
Obiekt żądania
- options
- RequestOptionsBase
Dodatkowe opcje do wysłania podczas wysyłania żądania
Zwraca
Promise<HttpOperationResponse>
Obiekt HttpOperationResponse zawierający ostateczne żądanie sondowania, odpowiedź i odpowiedźBody.
dziedziczone zResourceGraphClientContext.sendLongRunningRequest
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
Wyślij początkowe żądanie LRO (długotrwała operacja) i wróć do LROPoller, który udostępnia metody sondowania LRO I sprawdzania, czy LRO zostało zakończone.
function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>Parametry
- operationArguments
- OperationArguments
Argumenty operacji.
- operationSpec
- OperationSpec
Specyfikacja operacji.
- options
- RequestOptionsBase
Dodatkowe opcje do wysłania podczas wysyłania żądania.
Zwraca
Promise<@azure/ms-rest-azure-js.LROPoller>
Obiekt LROPoller, który zapewnia metody interakcji z LRO.
dziedziczone zResourceGraphClientContext.sendLRORequest
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parametry
- operationArguments
- OperationArguments
Argumenty, z których zostaną wypełnione wartości szablonowe żądania HTTP.
- operationSpec
- OperationSpec
Element OperationSpec do użycia w celu wypełnienia żądania httpRequest.
- callback
-
ServiceCallback<any>
Wywołanie zwrotne do wywołania po odebraniu odpowiedzi.
Zwraca
Promise<RestResponse>
dziedziczone zResourceGraphClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Wyślij podany element httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parametry
- options
Zwraca
Promise<HttpOperationResponse>
dziedziczone zResourceGraphClientContext.sendRequest