WorkspaceApiPolicy interface
Interface que representa um WorkspaceApiPolicy.
Métodos
| create |
Cria ou atualiza a configuração da política para a API. |
| delete(string, string, string, string, string, string, Workspace |
Exclui a configuração da política na Api. |
| get(string, string, string, string, string, Workspace |
Obtenha a configuração da política no nível da API. |
| get |
Obtém a versão do estado da entidade (Etag) da política de API especificada por seu identificador. |
| list |
Obtenha a configuração da política no nível da API. |
Detalhes de Método
createOrUpdate(string, string, string, string, string, PolicyContract, WorkspaceApiPolicyCreateOrUpdateOptionalParams)
Cria ou atualiza a configuração da política para a API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiPolicyCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- apiId
-
string
Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
- policyId
-
string
O identificador da Política.
- parameters
- PolicyContract
O conteúdo da política a aplicar.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, string, WorkspaceApiPolicyDeleteOptionalParams)
Exclui a configuração da política na Api.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, ifMatch: string, options?: WorkspaceApiPolicyDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- apiId
-
string
Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
- policyId
-
string
O identificador da Política.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, string, WorkspaceApiPolicyGetOptionalParams)
Obtenha a configuração da política no nível da API.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetOptionalParams): Promise<WorkspaceApiPolicyGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- apiId
-
string
Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
- policyId
-
string
O identificador da Política.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceApiPolicyGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiPolicyGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da política de API especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiPolicyGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- apiId
-
string
Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
- policyId
-
string
O identificador da Política.
Os parâmetros de opções.
Devoluções
listByApi(string, string, string, string, WorkspaceApiPolicyListByApiOptionalParams)
Obtenha a configuração da política no nível da API.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiPolicyListByApiOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- apiId
-
string
Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
Os parâmetros de opções.