azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.b...

279 строки
24 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.Certificates"
fullName: "com.azure.resourcemanager.batch.models.Certificates"
name: "Certificates"
nameWithType: "Certificates"
summary: "Resource collection API of Certificates."
syntax: "public interface **Certificates**"
methods:
- uid: "com.azure.resourcemanager.batch.models.Certificates.cancelDeletion(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.cancelDeletion(String resourceGroupName, String accountName, String certificateName)"
name: "cancelDeletion(String resourceGroupName, String accountName, String certificateName)"
nameWithType: "Certificates.cancelDeletion(String resourceGroupName, String accountName, String certificateName)"
summary: "Cancels a failed deletion of a certificate from the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Certificate cancelDeletion(String resourceGroupName, String accountName, String certificateName)"
desc: "Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Certificates.cancelDeletionWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
name: "cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
nameWithType: "Certificates.cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
summary: "Cancels a failed deletion of a certificate from the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Certificate> cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
desc: "Cancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Certificates.define(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.define(String name)"
name: "define(String name)"
nameWithType: "Certificates.define(String name)"
summary: "Begins definition for a new Certificate resource."
modifiers:
- "abstract"
parameters:
- description: "resource name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Certificate.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new Certificate resource."
returns:
description: "the first stage of the new Certificate definition."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Certificate.DefinitionStages.Blank?alt=com.azure.resourcemanager.batch.models.Certificate.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Certificates.delete(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.delete(String resourceGroupName, String accountName, String certificateName)"
name: "delete(String resourceGroupName, String accountName, String certificateName)"
nameWithType: "Certificates.delete(String resourceGroupName, String accountName, String certificateName)"
summary: "Deletes the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void delete(String resourceGroupName, String accountName, String certificateName)"
desc: "Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
- uid: "com.azure.resourcemanager.batch.models.Certificates.delete(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.delete(String resourceGroupName, String accountName, String certificateName, Context context)"
name: "delete(String resourceGroupName, String accountName, String certificateName, Context context)"
nameWithType: "Certificates.delete(String resourceGroupName, String accountName, String certificateName, Context context)"
summary: "Deletes the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract void delete(String resourceGroupName, String accountName, String certificateName, Context context)"
desc: "Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
- uid: "com.azure.resourcemanager.batch.models.Certificates.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Certificates.deleteById(String id)"
summary: "Deletes the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteById(String id)"
desc: "Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
- uid: "com.azure.resourcemanager.batch.models.Certificates.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Certificates.deleteByIdWithResponse(String id, Context context)"
summary: "Deletes the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract void deleteByIdWithResponse(String id, Context context)"
desc: "Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
- uid: "com.azure.resourcemanager.batch.models.Certificates.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.get(String resourceGroupName, String accountName, String certificateName)"
name: "get(String resourceGroupName, String accountName, String certificateName)"
nameWithType: "Certificates.get(String resourceGroupName, String accountName, String certificateName)"
summary: "Gets information about the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Certificate get(String resourceGroupName, String accountName, String certificateName)"
desc: "Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Certificates.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.getById(String id)"
name: "getById(String id)"
nameWithType: "Certificates.getById(String id)"
summary: "Gets information about the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Certificate getById(String id)"
desc: "Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Certificates.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Certificates.getByIdWithResponse(String id, Context context)"
summary: "Gets information about the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Certificate> getByIdWithResponse(String id, Context context)"
desc: "Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Certificates.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
name: "getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
nameWithType: "Certificates.getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
summary: "Gets information about the specified certificate."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier for the certificate. This must be made up of algorithm and thumbprint\n separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5."
name: "certificateName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<Certificate> getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)"
desc: "Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "contains information about a certificate."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Certificates.listByBatchAccount(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.listByBatchAccount(String resourceGroupName, String accountName)"
name: "listByBatchAccount(String resourceGroupName, String accountName)"
nameWithType: "Certificates.listByBatchAccount(String resourceGroupName, String accountName)"
summary: "Lists all of the certificates in the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<Certificate> listByBatchAccount(String resourceGroupName, String accountName)"
desc: "Lists all of the certificates in the specified account. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "values returned by the List operation as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Certificates.listByBatchAccount(java.lang.String,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Certificates.listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
name: "listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
nameWithType: "Certificates.listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
summary: "Lists all of the certificates in the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The maximum number of items to return in the response."
name: "maxresults"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- description: "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\".\n Only top level properties under properties/ are valid for selection."
name: "select"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "OData filter expression. Valid properties for filtering are \"properties/provisioningState\",\n \"properties/provisioningStateTransitionTime\", \"name\"."
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract PagedIterable<Certificate> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
desc: "Lists all of the certificates in the specified account. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "values returned by the List operation as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.batch.models.Certificate?alt=com.azure.resourcemanager.batch.models.Certificate&text=Certificate\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Certificates."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0