WorkspaceSubscription interface
Interfejs reprezentujący WorkspaceSubscription.
Metody
Szczegóły metody
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje subskrypcję określonego użytkownika do określonego produktu.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- parameters
- SubscriptionCreateParameters
Utwórz parametry.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Usuwa określoną subskrypcję.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Pobiera określoną jednostkę Subskrypcja.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) subskrypcji apimanagement określonej przez jej identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Wyświetla listę wszystkich subskrypcji obszaru roboczego w wystąpieniu usługi API Management.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Pobiera określone klucze subskrypcji.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Ponownie generuje klucz podstawowy istniejącej subskrypcji obszaru roboczego w wystąpieniu usługi API Management.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Ponownie generuje klucz pomocniczy istniejącej subskrypcji obszaru roboczego w wystąpieniu usługi API Management.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
Parametry opcji.
Zwraca
Promise<void>
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Aktualizuje szczegóły subskrypcji określonej przez jej identyfikator.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- sid
-
string
Identyfikator jednostki subskrypcji. Jednostka reprezentuje skojarzenie między użytkownikiem a produktem w usłudze API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- SubscriptionUpdateParameters
Aktualizuj parametry.
Parametry opcji.
Zwraca
Promise<WorkspaceSubscriptionUpdateResponse>